> ## 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 availability statuses

> List the organization's defined availability statuses (excluding deleted ones), ordered as shown in the dashboard.



## OpenAPI

````yaml get /availability-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:
  /availability-statuses:
    get:
      summary: List availability statuses
      description: >-
        List the organization's defined availability statuses (excluding deleted
        ones), ordered as shown in the dashboard. Each status carries its
        availability_type (whether applying it sets the user online or offline)
        and its display color. The hardcoded 'online' and 'offline' shortcuts
        are not listed — they are always applicable via the special field of
        applyUserAvailabilityStatus.
      operationId: listAvailabilityStatuses
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AvailabilityStatusDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    AvailabilityStatusDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/AvailabilityStatusDto'
      type: object
      properties:
        id:
          type: string
        org_id:
          type: string
        name:
          type: string
        group_ids:
          type: array
          items:
            type: string
        sort_order:
          type: number
        availability_type:
          type: string
          enum:
            - offline
            - online
          description: >-
            What applying the status does to the agent: 'online' turns main
            availability on with the status's teams; 'offline' turns main
            availability and every support team off (e.g. a Break status)
        color:
          type: string
          enum:
            - blue
            - gray
            - green
            - orange
            - red
          description: Display color for the status dot across the dashboard
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - id
        - org_id
        - name
        - group_ids
        - sort_order
        - availability_type
        - color
        - created_at
        - updated_at
        - deleted_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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