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



## OpenAPI

````yaml /openapi/config.json get /v1/crm/categories/
openapi: 3.0.3
info:
  title: Yume API — Конфигурация
  version: 1.0.0
  description: Управление настройками и конфигурацией CRM.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/categories/:
    get:
      tags:
        - categories
      summary: Get categories
      operationId: categories_list
      parameters:
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Category'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    Category:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        deleted:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Обновлен
        name:
          type: string
          maxLength: 255
        comment:
          type: string
          nullable: true
          maxLength: 512
        icon:
          type: string
          format: uri
          nullable: true
        slug:
          type: string
          nullable: true
          maxLength: 50
          pattern: ^[-a-zA-Z0-9_]+$
        lifetime:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        order:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        extra: {}
        tenant:
          type: integer
        parent:
          type: integer
          nullable: true
      required:
        - created_at
        - deleted
        - id
        - name
        - updated_at
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````