> ## 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. # Preview an invitation > Shows what an invitation link is for (organization, realm, role, who invited, whether the invitee already has an account), for the page the link opens. Needs no sign-in; the token is the secret. No authentication: anyone can call this. Token is the secret; used, revoked and expired invites answer with their status. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-invitations.yaml post /v1/invitations/get_by_token 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_token: post: tags: - Invitations summary: Preview an invitation description: >- Shows what an invitation link is for (organization, realm, role, who invited, whether the invitee already has an account), for the page the link opens. Needs no sign-in; the token is the secret. No authentication: anyone can call this. Token is the secret; used, revoked and expired invites answer with their status. operationId: POST_v1_invitations_get_by_token requestBody: required: true content: application/json: schema: type: object properties: token: type: string minLength: 1 description: The token from the invitation link. required: - token examples: default: value: token: inv_8f2c… 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: type: object properties: invite_id: type: string kind: type: string status: type: string enum: - pending - accepted - declined - revoked - expired org: type: object properties: slug: type: string display_name: type: string nullable: true realm: type: object nullable: true properties: slug: type: string display_name: type: string role: type: string inviter: type: object properties: display_name: type: string invitee_email: type: string account_exists: type: boolean description: >- The invitee already has an account; they must sign in to accept. expires_at: type: string example: ok: true data: invite_id: 3e4f5a6b-7c8d-4e9f-8a0b-1c2d3e4f5a6b kind: org_member status: pending org: slug: acme display_name: Acme Inc. realm: null role: member inviter: display_name: Sapan invitee_email: jdoe@acme.example account_exists: false expires_at: '2026-10-14T10:00:00Z' '404': description: '`not_found`: No invitation has this token.' content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found 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: 'token: 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: [] components: schemas: 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.