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

> List every custom session status in your organization. Use it to resolve a session's sub_status_id to a name, or to pick an id before applying one.

# List custom statuses



## OpenAPI

````yaml get /custom-statuses
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /custom-statuses:
    get:
      summary: List custom statuses
      description: >-
        List every custom session status defined for your organization. A custom
        status refines one of the built-in statuses (open, closed_resolved,
        closed_unresolved) with an agent-facing name and optional
        customer-facing label, color, and icon. A session carries at most one
        custom status in its `sub_status_id`; use this list to resolve that id
        to a name.
      operationId: listCustomStatuses
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomStatusesOutput'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    ListCustomStatusesOutput:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ListCustomStatusesOutput'
      type: array
      items:
        $ref: '#/components/schemas/CustomSessionStatusDto'
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    CustomSessionStatusDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/CustomSessionStatusDto'
      type: object
      properties:
        id:
          type: string
        org_id:
          type: string
        name:
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
        display_name:
          anyOf:
            - type: string
            - type: 'null'
        display_description:
          anyOf:
            - type: string
            - type: 'null'
        color:
          anyOf:
            - type: string
            - type: 'null'
        icon:
          anyOf:
            - type: string
            - type: 'null'
        parent_status:
          type: string
          enum:
            - closed_resolved
            - closed_unresolved
            - open
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - org_id
        - name
        - description
        - display_name
        - display_description
        - color
        - icon
        - parent_status
        - created_at
        - updated_at
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````