> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a user > Returns one user with counts of what they own (scopes, teams, tokens) and their organizations. You may read yourself, or members of an organization you administer (not site administrators). Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`). Results are limited to what that user can see. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-users.yaml post /v1/users/get_by_id openapi: 3.0.3 info: title: 'CliqHub API: Users' version: 1.0.0 description: >- User profiles. Which users you see depends on who you are: site administrators see everyone, organization admins see their members, everyone else sees themselves. Account administration (create, suspend, delete, passwords) is done by site administrators in the console. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Users description: >- User profiles. Which users you see depends on who you are: site administrators see everyone, organization admins see their members, everyone else sees themselves. Account administration (create, suspend, delete, passwords) is done by site administrators in the console. paths: /v1/users/get_by_id: post: tags: - Users summary: Get a user description: >- Returns one user with counts of what they own (scopes, teams, tokens) and their organizations. You may read yourself, or members of an organization you administer (not site administrators). Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`). Results are limited to what that user can see. operationId: POST_v1_users_get_by_id requestBody: required: true content: application/json: schema: type: object properties: user_id: type: string format: uuid description: The user. include_preferences: type: boolean default: false description: Also return their preferences. required: - user_id examples: default: value: user_id: 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: allOf: - $ref: '#/components/schemas/UserData' - type: object additionalProperties: true properties: scope_count: type: integer team_count: type: integer token_count: type: integer orgs: type: array items: type: object additionalProperties: true example: ok: true data: id: 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e username: jdoe display_name: Jane Doe email: jdoe@acme.example role: user suspended_at: null suspended_reason: null created_at: '2026-10-07T10:00:00Z' scope_count: 0 team_count: 2 token_count: 1 orgs: - slug: acme role: member '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: A daemon token was used; this route needs a user token. `forbidden`: You may not manage this user (they are a site administrator, or not a member of an organization you administer). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: Cannot manage site admins code: forbidden '404': description: >- `not_found`: No such user (or the account is deleted and you are not a site administrator). content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: User not found code: not_found '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'user_id: Required' code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: UserData: type: object properties: id: type: string format: uuid description: User UUID username: type: string description: Unique username / handle display_name: type: string description: Human-readable display name email: type: string description: Primary email address role: type: string enum: - user - admin description: Site-level role suspended_at: type: string nullable: true description: ISO timestamp when account was suspended; null if active suspended_reason: type: string description: Admin note on suspension; empty string when not suspended created_at: type: string description: ISO timestamp of account creation preferences: type: object additionalProperties: true description: User-controlled preference bag required: - id - username - display_name - email - role - suspended_at - suspended_reason - created_at - preferences HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.