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

# List Five9 Domains

> List the calling organization's Five9 Domains. A Domain is the provider-tenant record that anchors rate limits, per-action lane placement and the safety margin — N Connections against the same Domain share ONE budget. Each item carries the platform's own vocabulary in `tenancy_unit`, its raw per-window provider `caps`, the operator's `margin_pct`, and the `effective` budget computed from both. Sort with `sort_by`/`order` (default newest-first), paginate with `limit`/`skip`. Readable by any organization member.



## OpenAPI

````yaml /openapi.json get /platforms/five9/domains
openapi: 3.1.0
info:
  title: GetDialed Flows API
  version: 0.1.0
servers:
  - url: https://api.getdialed.ai/flows
    description: Production
security: []
paths:
  /platforms/five9/domains:
    get:
      tags:
        - five9-domains
      summary: List Five9 Domains
      description: >-
        List the calling organization's Five9 Domains. A Domain is the
        provider-tenant record that anchors rate limits, per-action lane
        placement and the safety margin — N Connections against the same Domain
        share ONE budget. Each item carries the platform's own vocabulary in
        `tenancy_unit`, its raw per-window provider `caps`, the operator's
        `margin_pct`, and the `effective` budget computed from both. Sort with
        `sort_by`/`order` (default newest-first), paginate with `limit`/`skip`.
        Readable by any organization member.
      operationId: list_five9_domains_platforms_five9_domains_get
      parameters:
        - name: sort_by
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Five9DomainSortBy'
            default: created_at
        - name: order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/Order'
            default: desc
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            default: 100
            title: Limit
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Skip
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Five9DomainResponse_'
        '401':
          description: Missing or invalid authentication
          content:
            application/json:
              example:
                detail: Authentication required
        '422':
          description: >-
            The body failed validation — an out-of-range safety margin, an
            unknown lane, an unknown rate bucket, an unknown action id, or an
            explicit null.
          content:
            application/json:
              example:
                detail: margins['Upload'] must be between 1 and 100
        '429':
          description: Rate limit exceeded — retry after the Retry-After header
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
          content:
            application/json:
              example:
                detail: 'Rate limit exceeded: 100 per 1 minute'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    Five9DomainSortBy:
      type: string
      enum:
        - created_at
        - domain_name
      title: Five9DomainSortBy
      description: Allowed sort fields when listing Five9 Domains.
    Order:
      type: string
      enum:
        - asc
        - desc
      title: Order
      description: |-
        Sort direction for config-family list endpoints (D-08).

        Renders as a real named enum (`components.schemas["Order"]`) in the
        generated OpenAPI so the Phase 50 typed client gets a compile-time
        `"asc" | "desc"` string-literal union.
    Page_Five9DomainResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Five9DomainResponse'
          type: array
          title: Items
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        limit:
          type: integer
          title: Limit
        skip:
          type: integer
          title: Skip
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
      type: object
      required:
        - items
        - limit
        - skip
      title: Page[Five9DomainResponse]
    Five9DomainResponse:
      properties:
        id:
          type: string
          title: Id
        org_id:
          type: string
          title: Org Id
        platform_id:
          type: string
          title: Platform Id
        domain_id:
          type: string
          title: Domain Id
        domain_name:
          type: string
          title: Domain Name
        api_host:
          type: string
          title: Api Host
        tenancy_unit:
          additionalProperties: true
          type: object
          title: Tenancy Unit
        buckets:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Buckets
        bucket_map:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Bucket Map
        lane_overrides:
          additionalProperties:
            type: string
          type: object
          title: Lane Overrides
        lane_order:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Lane Order
        sync_status:
          type: string
          title: Sync Status
        counters_synced_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Counters Synced At
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - org_id
        - platform_id
        - domain_id
        - domain_name
        - api_host
        - tenancy_unit
        - buckets
        - bucket_map
        - lane_overrides
        - lane_order
        - sync_status
        - counters_synced_at
        - status
        - created_at
        - updated_at
      title: Five9DomainResponse
      description: >-
        One Five9 Domain: the provider-tenant record that anchors rate limits.


        N Connections resolving to the same Domain share ONE quota budget. Each

        rate bucket reports the provider's raw `caps` per time window, the

        operator's `margin_pct` safety margin, and the `effective` budget
        computed

        from both. `tenancy_unit` carries the platform's own vocabulary for this

        record so it can be labelled correctly without a second lookup, and

        `sync_status` reports whether the caps are provider-observed (`live`),

        catalog defaults (`catalog_default`), or unchanged after a refresh
        returned

        unusable counters (`stale`).
      example:
        api_host: api.five9.com
        bucket_map:
          five9__configuration_service__add_to_list:
            operation_types:
              - Upload
            resolved: true
        buckets:
          Upload:
            caps:
              '60': 20
              '3600': 400
              '86400': 2000
            effective:
              '60': 16
              '3600': 320
              '86400': 1600
            label: Uploading (batch)
            margin_pct: 80
            max_records_per_request: 50000
            observed_at: '2026-07-25T18:00:00Z'
            source: live
        counters_synced_at: '2026-07-25T18:00:00Z'
        created_at: '2026-07-25T17:00:00Z'
        domain_id: '100200'
        domain_name: Acme Corp
        id: ten_9f2c1a7b3d4e5f60
        lane_order:
          bulk:
            - five9__configuration_service__add_to_list
        lane_overrides:
          five9__configuration_service__add_to_list: bulk
        org_id: org_a1b2c3d4
        platform_id: five9
        status: active
        sync_status: live
        tenancy_unit:
          key_field: domain_id
          key_source: getVCCConfiguration.domainId
          name: Domain
          plural: Domains
        updated_at: '2026-07-25T18:00:00Z'
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````