> ## Documentation Index
> Fetch the complete documentation index at: https://www.posted.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Read an invitation

> Looks up a valid invitation token without accepting it. Reports the team, invited email, role and whether email verification is required.

No signed-in session is required. Endpoint-specific tokens, setup secrets or challenges may still be required.

Looks up a valid invitation token without accepting it. Reports the team, invited email, role and whether email verification is required.

[Request conventions](/api-reference/overview) · [API keys](/api-keys) · [MCP connections](/mcp-connections)


## OpenAPI

````yaml api-reference/openapi.json GET /api/auth/invitation
openapi: 3.1.0
info:
  title: Posted HTTP API
  version: 0.2.0
  description: >-
    All registered application, account, OAuth, MCP transport and health
    endpoints. Publishing and draft request schemas come from the shared runtime
    validators. Replace the example server with your installation. Documentation
    uses simple request examples and does not execute live publishing requests.
servers:
  - url: https://posted-api.example.com
security: []
paths:
  /api/auth/invitation:
    get:
      tags:
        - Members and invitations
      summary: Read an invitation
      description: >-
        Looks up a valid invitation token without accepting it. Reports the
        team, invited email, role and whether email verification is required.


        No signed-in session is required. Endpoint-specific tokens, setup
        secrets or challenges may still be required.
      operationId: get_api_auth_invitation
      parameters:
        - name: token
          in: query
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{43}$
          description: string
      responses:
        '200':
          description: >-
            Successful response. Examples are illustrative; field values vary by
            record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  invitation:
                    type: object
                    properties:
                      email:
                        type: string
                      role:
                        type: string
                      verificationRequired:
                        type: boolean
                      workspaceName:
                        type: string
                    additionalProperties: true
                  verificationRequired:
                    type: boolean
                additionalProperties: true
              example:
                invitation:
                  email: sam@example.test
                  role: member
                  verificationRequired: true
                  workspaceName: Studio team
                verificationRequired: true
        default:
          description: >-
            Request failure. Inspect code, message and requestId; respect
            Retry-After on HTTP 429.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string

````

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