Aladdin Public API

Сотрудники (users:read)

GET /v1/users — примеры запросов, 200 и ошибки.

Сотрудники (users:read)

Метод — только GET. Запись и PII (email, телефон и т.п.) недоступны. См. Скрытые поля.

Базовый URL: https://api.aladdinhub.io/v1
Скоуп: users:read
Заголовок: Authorization: Bearer ald_…


GET /users — справочник (первая страница)

Запрос

GET /v1/users?limit=2 HTTP/1.1
Host: api.aladdinhub.io
Authorization: Bearer ald_demoPrefix_mockSecretExampleOnly
Accept: application/json
curl -sS \
  -H "Authorization: Bearer ald_demoPrefix_mockSecretExampleOnly" \
  -H "Accept: application/json" \
  "https://api.aladdinhub.io/v1/users?limit=2"

Ответ 200

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "name": "Example Author",
      "role": "manager",
      "department": "tech",
      "team": "platform",
      "isActive": true
    },
    {
      "id": "11111111-1111-4111-8111-111111111112",
      "name": "Example Assignee",
      "role": "developer",
      "department": "tech",
      "team": "platform",
      "isActive": true
    }
  ],
  "nextCursor": "eyJpZCI6IjExMTExMTExLTExMTEtNDExMS04MTExLTExMTExMTExMTExMiJ9",
  "limit": 2
}

Ошибки

КодКогдаПример тела
401токенниже
403нет users:read или IPниже
429rate limitниже
400limit вне 1…100ниже
{
  "statusCode": 401,
  "message": "Invalid or expired API token",
  "error": "Unauthorized"
}
{
  "statusCode": 403,
  "message": "Missing required API token scope: users:read",
  "error": "Forbidden"
}
{
  "statusCode": 403,
  "message": "Client IP is not allowed for this token",
  "error": "Forbidden"
}
{
  "statusCode": 429,
  "message": "Too Many Requests",
  "error": "Too Many Requests"
}
{
  "statusCode": 400,
  "message": ["limit must not be greater than 100"],
  "error": "Bad Request"
}

GET /users — следующая страница (cursor)

Запрос

GET /v1/users?limit=50&cursor=eyJpZCI6IjExMTExMTExLTExMTEtNDExMS04MTExLTExMTExMTExMTExMiJ9 HTTP/1.1
Host: api.aladdinhub.io
Authorization: Bearer ald_demoPrefix_mockSecretExampleOnly
Accept: application/json
curl -sS \
  -H "Authorization: Bearer ald_demoPrefix_mockSecretExampleOnly" \
  "https://api.aladdinhub.io/v1/users?limit=50&cursor=eyJpZCI6IjExMTExMTExLTExMTEtNDExMS04MTExLTExMTExMTExMTExMiJ9"

Ответ 200

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111113",
      "name": "Example Viewer",
      "role": "viewer",
      "department": "creative",
      "team": null,
      "isActive": true
    }
  ],
  "nextCursor": null,
  "limit": 50
}

Ошибки

Те же 401 / 403 / 429 / 400, что у первой страницы. Некорректный cursor обрабатывается как отсутствие курсора (первая страница), не как 400.