> ## 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 invites



## OpenAPI

````yaml /openapi/permissions.json get /v1/crm/invites/
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/crm/invites/:
    get:
      tags:
        - invites
      summary: Get invites
      operationId: invites_list
      parameters:
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StaffInvite'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    StaffInvite:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        token:
          type: string
          format: uuid
          readOnly: true
          title: Токен
        url:
          type: string
          readOnly: true
        email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        status:
          type: string
          readOnly: true
        group:
          type: integer
          nullable: true
          title: Роль
        group_name:
          type: string
          readOnly: true
        is_staff:
          type: boolean
          title: Сотрудник
        is_sublease:
          type: boolean
          title: Субаренда
        points:
          title: Точки аренды
        salary_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          nullable: true
        expires_at:
          type: string
          format: date-time
          title: Истекает
        sent_at:
          type: string
          format: date-time
          nullable: true
        accepted_at:
          type: string
          format: date-time
          nullable: true
        revoked_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        created_by:
          type: integer
          nullable: true
        created_by_name:
          type: string
          readOnly: true
      required:
        - created_at
        - created_by_name
        - group_name
        - id
        - status
        - token
        - url
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````