> ## 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 conversations

> Search, filter, and paginate conversations across agents in the workspace.

Returns `records`, `total`, `page`, `page_size`, and `can_review`. Pages start at 1; page size defaults to 25 and has a maximum of 100. An empty `records` array is a valid result.

Filter by agent, channel, state, outcome, date range, or review view. `search` is a text query. Date filters accept ISO 8601; a timezone offset or `Z` avoids ambiguity. The start must not be later than the end.

Use `can_review` to decide whether to show review actions. Each record's `id` is the numeric run ID used by the detail and review operations.


## OpenAPI

````yaml GET /api/v1/conversations
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/conversations:
    get:
      tags:
        - conversations
      summary: List conversations
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Search, filter, and paginate conversations across agents in the
        workspace.
      operationId: list_conversations_api_v1_conversations_get
      parameters:
        - in: query
          name: search
          required: false
          schema:
            default: ''
            maxLength: 200
            title: Search
            type: string
        - in: query
          name: start_date
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            title: Start Date
        - in: query
          name: end_date
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            title: End Date
        - in: query
          name: agent_id
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Agent Id
        - in: query
          name: channel
          required: false
          schema:
            anyOf:
              - enum:
                  - phone
                  - web
                  - chat
                type: string
              - type: 'null'
            title: Channel
        - in: query
          name: state
          required: false
          schema:
            anyOf:
              - enum:
                  - initialized
                  - running
                  - completed
                type: string
              - type: 'null'
            title: State
        - in: query
          name: outcome
          required: false
          schema:
            anyOf:
              - maxLength: 150
                type: string
              - type: 'null'
            title: Outcome
        - in: query
          name: view
          required: false
          schema:
            default: all
            enum:
              - all
              - needs_review
              - flagged
              - missing_artifacts
            title: View
            type: string
        - in: query
          name: sort
          required: false
          schema:
            default: created_at
            enum:
              - created_at
              - duration
              - agent
            title: Sort
            type: string
        - in: query
          name: order
          required: false
          schema:
            default: desc
            enum:
              - asc
              - desc
            title: Order
            type: string
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            title: Page
            type: integer
        - in: query
          name: page_size
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
        - 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/ConversationPage'
          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:
    ConversationPage:
      properties:
        can_review:
          default: false
          title: Can Review
          type: boolean
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        records:
          items:
            $ref: '#/components/schemas/ConversationRecord'
          title: Records
          type: array
        total:
          title: Total
          type: integer
      required:
        - records
        - total
        - page
        - page_size
      title: ConversationPage
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ConversationRecord:
      properties:
        agent_name:
          title: Agent Name
          type: string
        called_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Called Number
        caller_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Caller Number
        campaign_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Campaign Id
        channel:
          enum:
            - phone
            - web
            - chat
          title: Channel
          type: string
        cost_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Cost Usd
        created_at:
          format: date-time
          title: Created At
          type: string
        direction:
          anyOf:
            - type: string
            - type: 'null'
          title: Direction
        duration_seconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Duration Seconds
        end_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: End Reason
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        outcome:
          anyOf:
            - type: string
            - type: 'null'
          title: Outcome
        recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Recording Url
        review:
          $ref: '#/components/schemas/ConversationReview'
        state:
          title: State
          type: string
        transcript_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Transcript Url
        version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version
        workflow_id:
          title: Workflow Id
          type: integer
      required:
        - id
        - workflow_id
        - agent_name
        - name
        - created_at
        - channel
        - state
      title: ConversationRecord
      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
    ConversationReview:
      properties:
        flagged:
          default: false
          title: Flagged
          type: boolean
        history:
          items:
            additionalProperties: true
            type: object
          title: History
          type: array
        notes:
          items:
            additionalProperties: true
            type: object
          title: Notes
          type: array
        reviewer:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviewer
        revision:
          default: 0
          title: Revision
          type: integer
        status:
          default: not_reviewed
          enum:
            - not_reviewed
            - in_review
            - reviewed
          title: Status
          type: string
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      title: ConversationReview
      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.