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

# Get invite



## OpenAPI

````yaml /openapi/auth.json get /v1/auth/invite/{token}/
openapi: 3.0.3
info:
  title: Yume API — Аутентификация
  version: 1.0.0
  description: Регистрация, авторизация и управление сессиями пользователей.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/auth/invite/{token}/:
    get:
      tags:
        - invite
      summary: Get invite
      operationId: invite_retrieve
      parameters:
        - in: path
          name: token
          schema:
            type: string
            format: uuid
          required: true
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffInvitePublic'
          description: ''
      security:
        - {}
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    StaffInvitePublic:
      type: object
      properties:
        token:
          type: string
          format: uuid
          readOnly: true
          title: Токен
        email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        status:
          type: string
          readOnly: true
        company:
          type: string
          readOnly: true
        role:
          type: string
          readOnly: true
        user_exists:
          type: boolean
          readOnly: true
        expires_at:
          type: string
          format: date-time
          title: Истекает
      required:
        - company
        - role
        - status
        - token
        - user_exists

````