> ## 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 an invitation > Returns one invitation, with its delivery history. The invitation token is never shown. Requires a realm admin with the `realms.members.manage` permission on the realm that owns the invitation given by `invite_id`. For an organization-level invitation, a role with `org.members.manage` in that organization. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-invitations.yaml post /v1/invitations/get_by_id openapi: 3.0.3 info: title: 'CliqHub API: Invitations' version: 1.0.0 description: >- Invitations bring people into an organization (as member, admin or owner) or a realm (as member, operator or admin). Sending one emails a link; the person previews it and accepts or declines with the token in the link. Someone without an account sets their username and password when accepting, and gets a session token back. An invitation is `pending` until it is accepted, declined, revoked or expires (after 7 days); sending it again to the same address renews it. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Invitations description: >- Invitations bring people into an organization (as member, admin or owner) or a realm (as member, operator or admin). Sending one emails a link; the person previews it and accepts or declines with the token in the link. Someone without an account sets their username and password when accepting, and gets a session token back. An invitation is `pending` until it is accepted, declined, revoked or expires (after 7 days); sending it again to the same address renews it. paths: /v1/invitations/get_by_id: post: tags: - Invitations summary: Get an invitation description: >- Returns one invitation, with its delivery history. The invitation token is never shown. Requires a realm admin with the `realms.members.manage` permission on the realm that owns the invitation given by `invite_id`. For an organization-level invitation, a role with `org.members.manage` in that organization. operationId: POST_v1_invitations_get_by_id requestBody: required: true content: application/json: schema: type: object properties: invite_id: type: string format: uuid description: The invitation. target_type: type: string enum: - org - realm description: '`org` or `realm`; found in either when omitted.' required: - invite_id examples: default: value: invite_id: 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b 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: $ref: '#/components/schemas/Invitation' example: ok: true data: invite_id: 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b email: jdoe@acme.example role: member kind: org_member status: pending inviter: id: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d display_name: Sapan send_count: 1 last_sent_at: '2026-10-07T10:00:00Z' expires_at: '2026-10-14T10:00:00Z' deliveries: - kind: sent sent_at: '2026-10-07T10:00:00Z' email_sent: true provider_message_id: null created_at: '2026-10-07T10:00:00Z' '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`: You can see the record but your role in its realm is too low or lacks the required permission. 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 '404': description: >- `not_found`: The invitation does not exist or is in a realm you cannot see (404 rather than 403, so its existence is not revealed). `not_found`: No invitation has this id. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found not_found (endpoint): summary: not_found (endpoint) value: ok: false error: Invite 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: 'invite_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: Invitation: type: object properties: invite_id: type: string email: type: string role: type: string enum: - owner - admin - operator - member kind: type: string description: >- What the invitation is for, for example `org_member` or `realm_operator`. status: type: string enum: - pending - accepted - declined - revoked - expired inviter: type: object nullable: true properties: id: type: string display_name: type: string send_count: type: integer description: How many times it was sent. last_sent_at: type: string nullable: true expires_at: type: string deliveries: type: array items: type: object properties: kind: type: string enum: - sent - reminder sent_at: type: string email_sent: type: boolean provider_message_id: type: string nullable: true created_at: type: string 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.