# listUsers

Source: <https://telegafirst.com/docs/api-op-listusers>
Locale: ru
releaseGitSha: ea133cd4ad87fe549ef000b139be145be9bd1717
sourceContentDigest: e55b49381ca5420b10d26551e14086ca8b1c8822c94e6f142e245ba51482d795
Version: 2

# listUsers

`GET /api/v1/users`

List tenant users by their local sequence

## Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

| Поле | Значение |
| - | - |
| security.0.hubApiKey | \[] |
| security.1.hubBearer | \[] |
| securitySchemes.hubApiKey.in | "header" |
| securitySchemes.hubApiKey.name | "X-Api-Key" |
| securitySchemes.hubApiKey.type | "apiKey" |
| securitySchemes.hubBearer.scheme | "bearer" |
| securitySchemes.hubBearer.type | "http" |
| x-required-scopes | \["pull:users"] |

## Параметры запроса

| Поле | Значение |
| - | - |
| 0.in | "query" |
| 0.name | "cursor" |
| 0.required | false |
| 0.schema | [0.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 1.in | "query" |
| 1.name | "limit" |
| 1.required | false |
| 1.schema | [1.schema](https://telegafirst.com/docs/schema-d5a582c54cf7e16dda7dfbe23f8bd71caba8715bdbf71772e28e43981b674d3e) |
| 2.in | "query" |
| 2.name | "sort" |
| 2.required | false |
| 2.schema | [2.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 3.description | "Reserved parameter; User list does not expand relations." |
| 3.in | "query" |
| 3.name | "include" |
| 3.required | false |
| 3.schema | [3.schema](https://telegafirst.com/docs/schema-c3b9524f3831c894a8ae32823a8fa38dbc4a4caf30728e3dc3acd83f2e2f7bf5) |
| 4.description | "Tenant-local positive int4. Scalar or bracket operators gte/lte/gt/lt/eq/neq; comma lists are not supported." |
| 4.in | "query" |
| 4.name | "seq\_id" |
| 4.required | false |
| 4.schema | [4.schema](https://telegafirst.com/docs/schema-0c347328f4ce8e0dbd97cc8691764f1f57346b4d6d48a1665d515e9e58bc22c2) |
| 5.description | "Date or bracket operators gte/lte/gt/lt/eq/neq; comma lists are not supported." |
| 5.in | "query" |
| 5.name | "created\_at" |
| 5.required | false |
| 5.schema | [5.schema](https://telegafirst.com/docs/schema-a69fe49bf79dd743d5c46de8f41f31bc58ac62c81d45792316c7452a1023009f) |
| 6.description | "Date or bracket operators gte/lte/gt/lt/eq/neq; comma lists are not supported." |
| 6.in | "query" |
| 6.name | "updated\_at" |
| 6.required | false |
| 6.schema | [6.schema](https://telegafirst.com/docs/schema-a69fe49bf79dd743d5c46de8f41f31bc58ac62c81d45792316c7452a1023009f) |

## Тело запроса

| Поле | Значение |
| - | - |
| Тело запроса | null |

## Ответы

| Поле | Значение |
| - | - |
| 200.content.application/json.schema | [UserListEnvelope](https://telegafirst.com/docs/schema-6565496f537c4d4ab662272264b64145681a94766e93eeb72d548f447c6f4371) |
| 200.description | "User page with has\_more, next\_cursor, limit and optional estimated\_total" |
| 200.headers.X-Bot-Username.description | "Active bot public username, when API-key metadata contains it." |
| 200.headers.X-Bot-Username.schema | [200.headers.X-Bot-Username.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-Client-Slug.description | "Active tenant public slug, when API-key metadata contains it." |
| 200.headers.X-Client-Slug.schema | [200.headers.X-Client-Slug.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Limit.description | "Effective rate budget; fallback 120 without a per-key or request decision." |
| 200.headers.X-RateLimit-Limit.schema | [200.headers.X-RateLimit-Limit.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Remaining.description | "Nonnegative remaining count or unknown when no rate-limit decision is attached." |
| 200.headers.X-RateLimit-Remaining.schema | [200.headers.X-RateLimit-Remaining.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 200.headers.X-RateLimit-Reset.description | "Rate window reset as a Unix timestamp in seconds." |
| 200.headers.X-RateLimit-Reset.schema | [200.headers.X-RateLimit-Reset.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |

## Ошибки

| Поле | Значение |
| - | - |
| 400.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 400.description | "Invalid limit, filter or cursor" |
| 400.x-error-codes | \["INVALID\_REQUEST","INVALID\_FILTER","INVALID\_CURSOR"] |
| 401.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 401.description | "Missing, invalid, revoked or expired API credential" |
| 401.x-error-codes | \["INVALID\_API\_KEY"] |
| 403.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 403.description | "Missing scope, paid plan window, unsupported publishable key or no active business" |
| 403.x-error-codes | \["INSUFFICIENT\_SCOPE","PLAN\_UPGRADE\_REQUIRED","PUBLISHABLE\_KEY\_NOT\_ALLOWED","NO\_ACTIVE\_BOT"] |
| 413.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 413.description | "Per-tool request size or item count cap exceeded" |
| 413.x-error-codes | \["PAYLOAD\_TOO\_LARGE","ITEM\_COUNT\_EXCEEDED"] |
| 429.content.application/problem+json.schema | [ProblemDetails](https://telegafirst.com/docs/schema-c4113f3de00d728702a8663612e2074cbe3e8b3bb70d2b0dee6f3503fe89bd41) |
| 429.description | "Resource policy rate limit exceeded or subsystem unavailable" |
| 429.headers.Retry-After.description | "Retry delay in seconds when provided by the resource policy decision" |
| 429.headers.Retry-After.schema | [429.headers.Retry-After.schema](https://telegafirst.com/docs/schema-00404e686415370f1711c4d7acfa2905444d3cf23cef2e10c47d445ebe690f96) |
| 429.x-error-codes | \["RATE\_LIMIT\_EXCEEDED","RATE\_LIMIT\_UNAVAILABLE"] |

## Дополнительные условия

| Поле | Значение |
| - | - |
| description | "X-Api-Key or Bearer tgf\_\*; requires every declared scope. limit defaults to 50 (1..200). Encrypted keyset cursor expires after 900 seconds and is bound to tenant, resource and effective filters. sort is accepted but ordering remains created\_at desc/id desc. No ETag conditional response or Idempotency-Key requirement." |
| operationId | "listUsers" |
| summary | "List tenant users by their local sequence" |
| tags | \["users"] |