List the people of the workspace

GET /api/public/apps/v1/users

Needs the users:read permission.

Names and ids only. Pass next_cursor as cursor to read the next page.

Parameters

Name	In	Required	Meaning
limit	query	no	integer
cursor	query	no	The next_cursor of the previous page.

Example

curl

curl "https://amedeus.app/api/public/apps/v1/users" \
  -H "Authorization: Bearer $TOKEN"

JavaScript

const response = await fetch("https://amedeus.app/api/public/apps/v1/users", {
  headers: { Authorization: `Bearer ${process.env.TOKEN}` },
});
const result = await response.json(); // { ok: true, … } or { ok: false, error, message }

Python

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://amedeus.app/api/public/apps/v1/users",
    headers={
        "Authorization": f"Bearer {os.environ['TOKEN']}",
        "User-Agent": "my-app/1.0",
    },
)
with urllib.request.urlopen(request) as response:
    result = json.load(response)  # a 4xx or 5xx raises urllib.error.HTTPError

Response

Field	Type	Required	Meaning
ok	true	yes
users	array of object	yes
next_cursor	uuid or null	yes

{
  "ok": true,
  "users": [
    {
      "id": "52f4c823-8e7f-4349-bb98-1ac8683aad13",
      "display_name": "…",
      "is_bot": true
    }
  ],
  "next_cursor": null
}

Errors

Failures answer { "ok": false, "error": "<code>", "message": "…" }; see Errors.

• 400: The request isn’t valid.
• 401: The token is missing, wrong or revoked.
• 403: A missing scope (the message names it), or a channel the app isn’t in.
• 429: Slow down; Retry-After says for how many seconds.