Документация / Как начать / Работа с MCP / Идентификаторы и страницы результатов / REST: user / listUsers Для AI-агентов: markdown этой страницы — /docs/api-op-listusers.md · индекс документации — /llms.txt
listUsers Обновлено 4 октября 2026 г.
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 1.in "query" 1.name "limit" 1.required false 1.schema 1.schema 2.in "query" 2.name "sort" 2.required false 2.schema 2.schema 3.description "Reserved parameter; User list does not expand relations." 3.in "query" 3.name "include" 3.required false 3.schema 3.schema 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 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 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
# Тело запросаПоле Значение Тело запроса null
# ОтветыПоле Значение 200.content.application/json.schema UserListEnvelope 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 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 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 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 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
# ОшибкиПоле Значение 400.content.application/problem+json.schema ProblemDetails 400.description "Invalid limit, filter or cursor" 400.x-error-codes ["INVALID_REQUEST","INVALID_FILTER","INVALID_CURSOR"] 401.content.application/problem+json.schema ProblemDetails 401.description "Missing, invalid, revoked or expired API credential" 401.x-error-codes ["INVALID_API_KEY"] 403.content.application/problem+json.schema ProblemDetails 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 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 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 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"]