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

# List usage runs

> Retrieve paginated run usage and charges.

Pages start at 1. `limit` defaults to 50 and is capped at 100. `start_date` and `end_date` are inclusive ISO 8601 creation-time bounds. `filters` is a JSON-encoded array; supported shapes appear in the parameter reference. Unknown attributes and unsupported filter types are ignored. Use `callerNumber` and `calledNumber` as filter attribute names. In response objects, the corresponding fields are `caller_number` and `called_number`; the response field `phone_number` is deprecated.


## OpenAPI

````yaml GET /api/v1/organizations/usage/runs
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/organizations/usage/runs:
    get:
      tags:
        - usage
      summary: List usage runs
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Retrieve paginated run usage and charges.
      operationId: get_usage_history_api_v1_organizations_usage_runs_get
      parameters:
        - description: >-
            ISO 8601 date-time string (UTC). Lower bound (inclusive) on
            `created_at`.
          in: query
          name: start_date
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              ISO 8601 date-time string (UTC). Lower bound (inclusive) on
              `created_at`.
            examples:
              - '2026-04-01T00:00:00Z'
            title: Start Date
        - description: >-
            ISO 8601 date-time string (UTC). Upper bound (inclusive) on
            `created_at`.
          in: query
          name: end_date
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              ISO 8601 date-time string (UTC). Upper bound (inclusive) on
              `created_at`.
            examples:
              - '2026-05-01T00:00:00Z'
            title: End Date
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: limit
          required: false
          schema:
            default: 50
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: >
            JSON-encoded array of filter objects. Each object has the shape:


            ```json

            { "attribute": "<name>", "type": "<type>", "value": <value> }

            ```


            Supported `attribute` / `type` / `value` combinations:


            | attribute       | type          | value
            shape                                  |
            matches                                              |

            |-----------------|---------------|----------------------------------------------|------------------------------------------------------|

            | `runId`         | `number`      | `{ "value": 12345
            }`                         | exact run
            id                                         |

            | `workflowId`    | `number`      | `{ "value": 42
            }`                            | exact agent (workflow)
            id                            |

            | `campaignId`    | `number`      | `{ "value": 7
            }`                             | exact campaign
            id                                    |

            | `callerNumber`  | `text`        | `{ "value": "415555"
            }`                      | substring match on
            `initial_context.caller_number`   |

            | `calledNumber`  | `text`        | `{ "value": "9911848"
            }`                     | substring match on
            `initial_context.called_number`   |

            | `dispositionCode` | `multiSelect` | `{ "codes": ["XFER", "DNC"]
            }`             | any of the codes in
            `gathered_context.mapped_call_disposition` |

            | `duration`      | `numberRange` | `{ "min": 60, "max": 300
            }`                  | call duration (seconds), inclusive
            bounds            |


            Unknown attributes and unsupported `type` values are silently
            ignored.


            Date filtering on this endpoint is done via the dedicated
            `start_date` / `end_date` query params, not via a `dateRange` filter
            object.
          in: query
          name: filters
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >
              JSON-encoded array of filter objects. Each object has the shape:


              ```json

              { "attribute": "<name>", "type": "<type>", "value": <value> }

              ```


              Supported `attribute` / `type` / `value` combinations:


              | attribute       | type          | value
              shape                                  |
              matches                                              |

              |-----------------|---------------|----------------------------------------------|------------------------------------------------------|

              | `runId`         | `number`      | `{ "value": 12345
              }`                         | exact run
              id                                         |

              | `workflowId`    | `number`      | `{ "value": 42
              }`                            | exact agent (workflow)
              id                            |

              | `campaignId`    | `number`      | `{ "value": 7
              }`                             | exact campaign
              id                                    |

              | `callerNumber`  | `text`        | `{ "value": "415555"
              }`                      | substring match on
              `initial_context.caller_number`   |

              | `calledNumber`  | `text`        | `{ "value": "9911848"
              }`                     | substring match on
              `initial_context.called_number`   |

              | `dispositionCode` | `multiSelect` | `{ "codes": ["XFER", "DNC"]
              }`             | any of the codes in
              `gathered_context.mapped_call_disposition` |

              | `duration`      | `numberRange` | `{ "min": 60, "max": 300
              }`                  | call duration (seconds), inclusive
              bounds            |


              Unknown attributes and unsupported `type` values are silently
              ignored.


              Date filtering on this endpoint is done via the dedicated
              `start_date` / `end_date` query params, not via a `dateRange`
              filter object.
            examples:
              - >-
                [{"attribute":"callerNumber","type":"text","value":{"value":"415555"}}]
              - >-
                [{"attribute":"campaignId","type":"number","value":{"value":7}},{"attribute":"duration","type":"numberRange","value":{"min":60,"max":300}}]
              - >-
                [{"attribute":"dispositionCode","type":"multiSelect","value":{"codes":["XFER","DNC"]}}]
            title: Filters
        - description: >-
            Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace
            ID to access. The key owner must be a current member. Missing or
            invalid IDs return 400; non-member workspaces return 403. Not
            required for bearer authentication, which uses the user's selected
            workspace.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Required with X-BW-LABS-AGENTS-API-KEY: the positive local
              workspace ID to access. The key owner must be a current member.
              Missing or invalid IDs return 400; non-member workspaces return
              403. Not required for bearer authentication, which uses the user's
              selected workspace.
            title: X-Voai-Organization-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageHistoryResponse'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    UsageHistoryResponse:
      properties:
        limit:
          title: Limit
          type: integer
        page:
          title: Page
          type: integer
        runs:
          items:
            $ref: '#/components/schemas/WorkflowRunUsageResponse'
          title: Runs
          type: array
        total_count:
          title: Total Count
          type: integer
        total_duration_seconds:
          title: Total Duration Seconds
          type: integer
        total_pages:
          title: Total Pages
          type: integer
        total_voai_tokens:
          title: Total Tokens
          type: number
      required:
        - runs
        - total_voai_tokens
        - total_duration_seconds
        - total_count
        - page
        - limit
        - total_pages
      title: UsageHistoryResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    WorkflowRunUsageResponse:
      properties:
        call_duration_seconds:
          title: Call Duration Seconds
          type: integer
        call_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Call Type
        called_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Called Number
        caller_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Caller Number
        charge_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Charge Usd
        created_at:
          title: Created At
          type: string
        disposition:
          anyOf:
            - type: string
            - type: 'null'
          title: Disposition
        gathered_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Gathered Context
        id:
          title: Id
          type: integer
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Initial Context
        mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Mode
        name:
          title: Name
          type: string
        phone_number:
          anyOf:
            - type: string
            - type: 'null'
          deprecated: true
          title: Phone Number
        recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Recording Url
        transcript_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Transcript Url
        voai_token_usage:
          title: Token Usage
          type: number
        workflow_id:
          title: Workflow Id
          type: integer
        workflow_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Name
      required:
        - id
        - workflow_id
        - workflow_name
        - name
        - created_at
        - voai_token_usage
        - call_duration_seconds
      title: WorkflowRunUsageResponse
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

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