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

# List voice deployment logs for a worker with optional filtering and pagination

> Retrieves voice deployment logs for the worker with pagination support. Optionally, logs can be filtered by deploymentId and/or flowId by providing corresponding query parameters.




## OpenAPI

````yaml /openapi-specs/brainbase-openapi.documented.json get /api/workers/{workerId}/deploymentLogs/voice
openapi: 3.0.0
info:
  title: Brainbase REST API
  version: 1.0.3
  description: API documentation for Brainbase REST API
servers:
  - url: https://brainbase-monorepo-api.onrender.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Team
    description: Endpoints related to team functionalities
  - name: Integrations
    description: Endpoints for integrations
  - name: Assets
    description: Endpoints for asset management
  - name: Workers
    description: Endpoints for worker operations
  - name: Flows
    description: Endpoints for flow management
  - name: Voice Deployments
    description: Endpoints for voice deployments
  - name: Voice V1 Deployments
    description: Endpoints for voice v1 deployments
  - name: Voice Deployment Logs
    description: Endpoints for voice deployment logs
  - name: Voice Deployment Outbound Data
    description: Endpoints for voice deployment outbound data
  - name: Chat Deployments
    description: Endpoints for chat deployments
  - name: Chat Deployment Logs
    description: Endpoints for chat deployment logs
  - name: Tags
    description: Endpoints for tag management and worker tag assignment
  - name: Echo
    description: Endpoints for Echo test suites, agents, and scorecards
  - name: Flow Versions
    description: Endpoints for flow version control
  - name: Deployment History
    description: Endpoints for deployment change history
  - name: Deployment Parameters
    description: Endpoints for deployment parameters
  - name: Log Exports
    description: Endpoints for async log export to CSV/JSON
  - name: Logs
    description: >-
      Universal log lookup — fetch any deployment log by ID without needing
      worker or deployment context
  - name: Deployments
    description: >-
      Universal deployment lookup — fetch any deployment by ID without needing
      worker context
paths:
  /api/workers/{workerId}/deploymentLogs/voice:
    get:
      tags:
        - Voice Deployment Logs
      summary: >-
        List voice deployment logs for a worker with optional filtering and
        pagination
      description: >
        Retrieves voice deployment logs for the worker with pagination support.
        Optionally, logs can be filtered by deploymentId and/or flowId by
        providing corresponding query parameters.
      parameters:
        - name: workerId
          in: path
          required: true
          schema:
            type: string
        - name: deploymentId
          in: query
          required: false
          schema:
            type: string
          description: Filter logs by deployment id
        - name: flowId
          in: query
          required: false
          schema:
            type: string
          description: Filter logs by flow id
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - inbound
              - outbound
          description: Filter by call direction
        - name: fromNumber
          in: query
          required: false
          schema:
            type: string
          description: Filter by caller phone number (partial match)
        - name: toNumber
          in: query
          required: false
          schema:
            type: string
          description: Filter by called phone number (partial match)
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: Filter by call status
        - name: externalCallId
          in: query
          required: false
          schema:
            type: string
          description: Filter by external call ID
        - name: callSid
          in: query
          required: false
          schema:
            type: string
          description: Filter by Twilio call SID
        - name: searchQuery
          in: query
          required: false
          schema:
            type: string
          description: Search in call transcriptions (case-insensitive)
        - name: startTimeAfter
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter logs with startTime after this date (ISO 8601 format)
        - name: startTimeBefore
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter logs with startTime before this date (ISO 8601 format)
        - name: endTimeAfter
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter logs with endTime after this date (ISO 8601 format)
        - name: endTimeBefore
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Filter logs with endTime before this date (ISO 8601 format)
        - name: startDate
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Deprecated - use startTimeAfter instead
        - name: endDate
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Deprecated - use startTimeBefore instead
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - startTime
              - endTime
              - direction
              - fromNumber
              - toNumber
              - status
              - externalCallId
              - duration
              - createdAt
              - updatedAt
            default: startTime
          description: Field to sort by
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort order (ascending or descending)
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Number of items per page
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Alias for limit
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for cursor-based pagination (value of nextCursor from a
            previous response)
        - name: minDuration
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Filter logs with duration greater than or equal to this value
            (seconds)
        - name: maxDuration
          in: query
          required: false
          schema:
            type: integer
          description: Filter logs with duration less than or equal to this value (seconds)
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: >
            Comma-separated list of fields to include in the response. When
            omitted, all fields are returned. The `id` field is always included.
            Allowed fields: id, createdAt, updatedAt, workerId, deploymentId,
            flowId, bbEngineSessionId, extractionsData, metadata, flowSnapshot,
            sessionLogData, type, startTime, endTime, externalCallId, direction,
            fromNumber, toNumber, transcription, messages, recordingUrl, data,
            Telephony_source, status, call_sid, duration, successResults,
            transferData
          example: id,startTime,status,direction,duration
      responses:
        '200':
          description: Paginated list of voice deployment logs
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: '#/components/schemas/VoiceDeploymentLog'
                        - type: object
                          properties:
                            transferData:
                              nullable: true
                              description: >-
                                Transfer data associated with this call, if any.
                                `metrics.transfers` is 1 for a call with a
                                transfer record and aligns with voice analysis
                                transfer counts; `metrics.transferEvents` is the
                                raw callback/event count.
                              allOf:
                                - $ref: '#/components/schemas/TwilioCallTransferData'
                                - type: object
                                  properties:
                                    transferEvents:
                                      type: array
                                      items:
                                        $ref: '#/components/schemas/TwilioTransferEvent'
                                    metrics:
                                      type: object
                                      properties:
                                        transfers:
                                          type: number
                                        transferMinutes:
                                          type: number
                                        transferEvents:
                                          type: number
                                        transferEventMinutes:
                                          type: number
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Cursor to pass as the `cursor` param to fetch the next
                      page. Null when no more pages.
                  hasMore:
                    type: boolean
                    description: Whether more results exist beyond this page
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Current page number
                      limit:
                        type: integer
                        description: Items per page
                      total:
                        type: integer
                        description: Total number of items
                      totalPages:
                        type: integer
                        description: Total number of pages
                      hasNext:
                        type: boolean
                        description: Whether there is a next page
                      hasPrev:
                        type: boolean
                        description: Whether there is a previous page
        '400':
          description: Invalid pagination parameters
        '401':
          description: Unauthorized
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import BrainbaseLabs from 'brainbase-labs';


            const client = new BrainbaseLabs({
              apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
            });


            const voices = await
            client.workers.deploymentLogs.voice.list('workerId');


            console.log(voices.data);
        - lang: Python
          source: |-
            import os
            from brainbase_labs import BrainbaseLabs

            client = BrainbaseLabs(
                api_key=os.environ.get("BRAINBASE_LABS_API_KEY"),  # This is the default and can be omitted
            )
            voices = client.workers.deployment_logs.voice.list(
                worker_id="workerId",
            )
            print(voices.data)
components:
  schemas:
    VoiceDeploymentLog:
      type: object
      properties:
        id:
          type: string
          nullable: false
        startTime:
          type: string
          nullable: true
          format: date-time
        endTime:
          type: string
          nullable: true
          format: date-time
        externalCallId:
          type: string
          nullable: true
        direction:
          type: string
          nullable: true
        fromNumber:
          type: string
          nullable: true
        toNumber:
          type: string
          nullable: true
        transcription:
          type: string
          nullable: true
        messages:
          type: object
          nullable: true
        recordingUrl:
          type: string
          nullable: true
        data:
          type: object
          nullable: true
          description: >-
            Additional structured data from the call, including post-call
            analytics and latency metrics
          properties:
            latency:
              type: object
              description: >-
                End-to-end and component latency metrics measured in
                milliseconds
            tts:
              type: object
              description: Text-to-speech latency metrics measured in milliseconds
            llm_websocket_network_rtt:
              type: number
              description: >-
                Network round-trip time for the LLM websocket connection in
                milliseconds
        Telephony_source:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        call_sid:
          type: string
          nullable: true
        duration:
          type: integer
          nullable: true
      required:
        - id
    TwilioCallTransferData:
      type: object
      properties:
        id:
          type: string
          nullable: false
        createdAt:
          type: string
          nullable: false
          format: date-time
        updatedAt:
          type: string
          nullable: false
          format: date-time
        callSid:
          type: string
          nullable: false
        status:
          type: string
          nullable: true
        duration:
          type: string
          nullable: true
        voiceLogId:
          type: string
          nullable: false
      required:
        - id
        - createdAt
        - updatedAt
        - callSid
        - voiceLogId
    TwilioTransferEvent:
      type: object
      properties:
        id:
          type: string
          nullable: false
        createdAt:
          type: string
          nullable: false
          format: date-time
        type:
          type: string
          nullable: true
        timestamp:
          type: string
          nullable: true
          format: date-time
        duration:
          type: string
          nullable: false
        toNumber:
          type: string
          nullable: false
        fromNumber:
          type: string
          nullable: false
        parentCallSid:
          type: string
          nullable: true
        callSid:
          type: string
          nullable: true
        callTransferId:
          type: string
          nullable: false
      required:
        - id
        - createdAt
        - duration
        - toNumber
        - fromNumber
        - callTransferId
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication

````