Документация / Как начать / Работа с MCP / Идентификаторы и страницы результатов / REST: user / getUser Для AI-агентов: markdown этой страницы — /docs/api-op-getuser.md · индекс документации — /llms.txt
getUser Обновлено 4 октября 2026 г.
GET /api/v1/users/{seq_id}
Read a tenant user and permitted relation projections
# Авторизация и права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 "path" 0.name "seq_id" 0.required true 0.schema 0.schema 1.description "orders,subscription (one level, comma-separated)" 1.in "query" 1.name "include" 1.required false 1.schema 1.schema
# Тело запросаПоле Значение Тело запроса null
# ОтветыПоле Значение 200.content.application/json.schema UserDetail 200.description "User with optional tenant-scoped order/subscription projections" 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 positive-int4 address or include" 400.x-error-codes ["INVALID_REQUEST"] 401.content.application/problem+json.schema ProblemDetails 401.description "Missing or invalid API credential/JWT" 401.x-error-codes ["UNAUTHORIZED","INVALID_API_KEY","EXPIRED_JWT","INVALID_REFRESH_TOKEN"] 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"] 404.content.application/problem+json.schema ProblemDetails 404.description "User sequence was not found in the selected tenant" 404.x-error-codes ["NOT_FOUND"] 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 "Resolves (client_id, seq_id), never a platform PK. ApiKeyOrJwtGuard accepts X-Api-Key, Bearer tgf_* or a verified surface JWT. ScopeGuard still requires pull:users: a scope-free surface JWT authenticates then fails 403. This does not assert owner OAuth/MCP parity. include accepts orders,subscription, comma-separated at one level; omitted includes are absent. No ETag conditional response or Idempotency-Key requirement." operationId "getUser" summary "Read a tenant user and permitted relation projections" tags ["users"]