> ## 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 everything holding dispatch

> List the calling organization's pause records — admin holds and automatic rate-limit backoffs alike, each with its machine-readable `cause`. By default only active holds return; `include_released=true` adds released history (release is not deletion). Filter by `scope`, sort with `sort_by`/`order` (default newest-first), paginate with `limit`/`skip`. Readable by any organization member.



## OpenAPI

````yaml /openapi.json get /admin/dispatch/pauses
openapi: 3.1.0
info:
  title: GetDialed Flows API
  version: 0.1.0
servers:
  - url: https://api.getdialed.ai/flows
    description: Production
security: []
paths:
  /admin/dispatch/pauses:
    get:
      tags:
        - dispatch
      summary: List everything holding dispatch
      description: >-
        List the calling organization's pause records — admin holds and
        automatic rate-limit backoffs alike, each with its machine-readable
        `cause`. By default only active holds return; `include_released=true`
        adds released history (release is not deletion). Filter by `scope`, sort
        with `sort_by`/`order` (default newest-first), paginate with
        `limit`/`skip`. Readable by any organization member.
      operationId: list_dispatch_pauses_admin_dispatch_pauses_get
      parameters:
        - name: include_released
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Released
        - name: scope
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/DispatchPauseScope'
              - type: 'null'
            title: Scope
        - name: sort_by
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/DispatchPauseSortBy'
            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_DispatchPauseResponse_'
        '401':
          description: Missing or invalid authentication
          content:
            application/json:
              example:
                detail: Authentication required
        '422':
          description: >-
            The body failed validation — an out-of-range duration, an over-long
            reason, an unknown lane or bucket, or lane/bucket scoping on the
            break-glass endpoint.
          content:
            application/json:
              example:
                detail: >-
                  The global pause holds every Domain at once — use the Domain
                  pause endpoints for lane or bucket scoping.
        '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:
    DispatchPauseScope:
      type: string
      enum:
        - global
        - domain
        - lane
        - bucket
        - batch
      title: DispatchPauseScope
      description: >-
        How much of dispatch a pause holds.


        `global` holds every Domain in the organization; `domain` holds one

        Domain; `lane` holds one named dispatch lane; `bucket` holds one
        provider

        rate bucket (the shape automatic backoffs use); `batch` holds one batch.
    DispatchPauseSortBy:
      type: string
      enum:
        - created_at
        - expires_at
      title: DispatchPauseSortBy
      description: Allowed sort fields when listing dispatch pauses.
    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_DispatchPauseResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/DispatchPauseResponse'
          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[DispatchPauseResponse]
    DispatchPauseResponse:
      properties:
        id:
          type: string
          title: Id
        scope:
          type: string
          title: Scope
        tenancy_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tenancy Id
        bucket:
          anyOf:
            - type: string
            - type: 'null'
          title: Bucket
        lane:
          anyOf:
            - type: string
            - type: 'null'
          title: Lane
        batch_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Batch Id
        status:
          type: string
          title: Status
        cause:
          type: string
          title: Cause
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        released_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Released At
        released_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Released By
        extensions:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Extensions
      type: object
      required:
        - id
        - scope
        - tenancy_id
        - bucket
        - lane
        - batch_id
        - status
        - cause
        - reason
        - created_by
        - created_at
        - expires_at
        - released_at
        - released_by
        - extensions
      title: DispatchPauseResponse
      description: |-
        One hold on dispatch — an admin hold or an automatic backoff.

        Both kinds share this one shape, so a single listing shows everything
        currently holding dispatch. `scope` says how much is held and the
        matching target field (`tenancy_id`, `lane`, `bucket`, or `batch_id`)
        says exactly what. `cause` is the machine-readable origin
        (`admin_request` for a human hold, the provider fault tag for an
        automatic backoff) and `reason` is the human note, if any. A released
        pause keeps its record: `released_at` and `released_by` complete the
        audit trail, and `extensions` lists every time a scheduled resume was
        pushed out.
      example:
        cause: admin_request
        created_at: '2026-07-29T12:00:00Z'
        created_by: user_11223344
        expires_at: '2026-07-29T13:00:00Z'
        extensions: []
        id: pause_9f2c1a7b3d4e5f60
        reason: Provider maintenance window
        scope: global
        status: active
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````