> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Look up an invitation

> Returns the invitation an invitation link's token refers to: the
organization, invited email and role. Needs no authentication. Returns 404
when the token is unknown or the invitation has expired.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/auth/verify-invitation
openapi: 3.1.0
info:
  title: Qumo Deploy REST API
  description: >
    The Qumo Deploy control plane: organizations, projects, signing keys,
    machine

    identities, access control, audit and billing. Relay credentials are not

    issued here: your app signs them with its own

    [signing keys](/guides/signing-keys).


    Every operation here is generated against the routes the server registers

    and checked in CI, so an operation in this reference exists and a route

    missing from it is deliberately internal (relay mesh, webhooks, probes,

    operator-only and browser sign-in routes).


    Errors are JSON objects with one `error` field. What each status code means

    is in [Error codes](/guides/error-codes); the token scope each permission

    needs is in [Scopes and permissions](/guides/scopes-permissions).
  version: 1.0.0
servers:
  - url: https://api.qumo-deploy.com
    description: Public API (Bearer tokens only; cookies are ignored)
security: []
tags:
  - name: Account
    description: The signed-in user's own sessions, tokens, security settings and data.
  - name: Device flow
    description: OAuth 2.0 device authorization, used by `qumod login`.
  - name: Organizations
    description: Organizations, their members and usage.
  - name: Projects
    description: Projects inside an organization.
  - name: Signing keys
    description: Keys your app signs relay credentials with.
  - name: Relays
    description: Where clients of a broadcast path connect.
  - name: Identities
    description: Machine identities, their tokens and IP allowlists.
  - name: Access control
    description: Roles, IAM bindings and invitations.
  - name: Audit
    description: The audit log and its webhook.
  - name: Notifications
    description: Notification policies.
  - name: Billing
    description: Plans, usage cost, budgets, invoices and payment methods.
  - name: Pricing
    description: Public price list.
paths:
  /v1/auth/verify-invitation:
    post:
      tags:
        - Access control
      summary: Look up an invitation
      description: >
        Returns the invitation an invitation link's token refers to: the

        organization, invited email and role. Needs no authentication. Returns
        404

        when the token is unknown or the invitation has expired.
      operationId: verifyInvitation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationVerifyRequest'
      responses:
        '200':
          description: The invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationVerifyResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
      security: []
components:
  schemas:
    InvitationVerifyRequest:
      type: object
      required:
        - token
      properties:
        token:
          type: string
          description: The token from the invitation link.
          example: 9sK2mP7xQ4vL1nR8tW3cZ6bY0hJ5fD2a
    InvitationVerifyResponse:
      type: object
      required:
        - invitation
      properties:
        invitation:
          $ref: '#/components/schemas/Invitation'
    Invitation:
      type: object
      required:
        - id
        - organization_id
        - email
        - role_id
        - expires_at
        - created_at
      properties:
        id:
          type: string
          format: uuid
          example: e4b6d8f0-2a3c-4e5f-9b7d-1c3e5a7b9d2f
        organization_id:
          type: string
          format: uuid
          example: 3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c
        email:
          type: string
          format: email
          example: kenji@example.com
        role_id:
          type: string
          example: roles/project.editor
        expires_at:
          type: string
          format: date-time
          example: '2026-11-10T08:00:00Z'
        created_at:
          type: string
          format: date-time
          example: '2026-11-03T08:00:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: A human-readable message.
          example: organization_id is required
  responses:
    BadRequest:
      description: >-
        Malformed request or failed validation. See [Error
        codes](/guides/error-codes).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        Not found, or not visible to the caller. See [Error
        codes](/guides/error-codes).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.