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

# List dialed campaign customers

> One row per customer per campaign, for every customer actually dialed in the window: the endpoint for "who did we call" and for counting unique people reached (`campaign-analytics` reports dial attempts, so a customer dialed four times contributes four to its `calls_made`). Only dialed customers appear; enrollment alone is not enough, so a text-only campaign returns nothing here — use `campaign-enrollments` for every member. The grain is (campaign, customer): someone in two campaigns returns two rows, distinguished by `campaign_id`; for a distinct-person total, group on `customer_phone_number` client-side. Keyset-paginated on enrollment time. Always scoped to the team in the URL path. Requires the `read:outbound` permission.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/teams/{teamId}/outbound/campaign-customers
openapi: 3.1.0
info:
  title: Avoca Enterprise API
  description: >-
    Read-only programmatic access to Avoca data: calls and recordings,
    transcripts, leads, coach evaluations, Simple Scheduler sessions and
    analytics, outbound texting activity, enterprise support tickets, and
    customer survey results.
  version: 1.5.0
servers:
  - url: https://enterprise-api.avoca.ai
security:
  - bearerAuth: []
tags:
  - name: Calls
    description: Call records, recordings, transcripts, and pre-call transfers
  - name: Leads
    description: Unified leads (v0) and the canonical leads feed (v1)
  - name: Teams
    description: Teams accessible to the API key
  - name: Coach
    description: Coach (QA) call evaluations and rubrics
  - name: Scheduler Analytics (v0)
    description: Simple Scheduler analytics — legacy flat endpoints
  - name: Sessions & Bookings
    description: v1 scheduling-widget sessions and completed bookings
  - name: Analytics (v1)
    description: v1 funnel, UTM, service-area, and issue-type analytics
  - name: Outbound Texting
    description: Campaign text and subscription-event feeds for BI ingestion
  - name: Support Tickets
    description: Customer-safe enterprise support-ticket feed
  - name: Surveys
    description: >-
      Post-call customer survey results (CSAT, resolution, feedback) for BI
      ingestion
paths:
  /api/v1/teams/{teamId}/outbound/campaign-customers:
    get:
      tags:
        - Outbound Texting
      summary: List dialed campaign customers
      description: >-
        One row per customer per campaign, for every customer actually dialed in
        the window: the endpoint for "who did we call" and for counting unique
        people reached (`campaign-analytics` reports dial attempts, so a
        customer dialed four times contributes four to its `calls_made`). Only
        dialed customers appear; enrollment alone is not enough, so a text-only
        campaign returns nothing here — use `campaign-enrollments` for every
        member. The grain is (campaign, customer): someone in two campaigns
        returns two rows, distinguished by `campaign_id`; for a distinct-person
        total, group on `customer_phone_number` client-side. Keyset-paginated on
        enrollment time. Always scoped to the team in the URL path. Requires the
        `read:outbound` permission.
      operationId: listOutboundCampaignCustomers
      parameters:
        - $ref: '#/components/parameters/teamIdPath'
        - name: start_date
          in: query
          required: true
          description: Include dials placed on/after this ISO 8601 timestamp.
          schema:
            type: string
            format: date-time
        - name: end_date
          in: query
          required: true
          description: Include dials placed before this ISO 8601 timestamp.
          schema:
            type: string
            format: date-time
        - name: campaign_status
          in: query
          required: false
          description: >-
            Comma-separated campaign statuses (default
            `ACTIVE,DRAINING,SCHEDULED,COMPLETED`).
          schema:
            type: string
            default: ACTIVE,DRAINING,SCHEDULED,COMPLETED
        - name: campaign_id
          in: query
          required: false
          description: >-
            Comma-separated campaign ids to narrow to (max 200). Discover ids
            with the campaigns endpoint.
          schema:
            type: string
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit500default50'
      responses:
        '200':
          description: Paginated dialed customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CampaignCustomer'
                  pagination:
                    $ref: '#/components/schemas/CursorPagination'
                  meta:
                    type: object
                    properties:
                      team_id:
                        type: integer
                      start_date:
                        type: string
                        format: date-time
                      end_date:
                        type: string
                        format: date-time
                      campaign_status:
                        type: array
                        items:
                          type: string
                        description: The effective status filter
                      campaign_id:
                        type: array
                        items:
                          type: integer
                        description: Present when `campaign_id` narrowed the request
                      campaign_count:
                        type: integer
                        description: Campaigns the filters resolved to
                      truncated_campaigns:
                        type: boolean
                        description: >-
                          True when the filters matched more than 500 campaigns;
                          narrow with `campaign_status` or `campaign_id`
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teamIdPath:
      name: teamId
      in: path
      required: true
      description: The team ID
      schema:
        type: integer
    cursor:
      name: cursor
      in: query
      description: >-
        Opaque pagination cursor from the previous response's
        `pagination.cursor`
      schema:
        type: string
    limit500default50:
      name: limit
      in: query
      description: Results per page (default 50, max 500)
      schema:
        type: integer
        default: 50
        maximum: 500
  schemas:
    CampaignCustomer:
      type: object
      description: >-
        One customer's outbound dial activity within one campaign. Only
        customers dialed in the requested window appear.
      properties:
        campaign_id:
          type: integer
        campaign_name:
          type:
            - string
            - 'null'
        campaign_status:
          type: string
          description: Raw campaign status
          enum:
            - CREATED
            - SCHEDULED
            - ACTIVE
            - DRAINING
            - PAUSED
            - COMPLETED
        customer_id:
          type:
            - string
            - 'null'
          description: CRM customer identifier; null for CSV-imported audiences
        customer_name:
          type:
            - string
            - 'null'
        customer_phone_number:
          type:
            - string
            - 'null'
          description: >-
            The reliable identity key; joins `campaign-enrollments` and
            `campaign-texts`
        enrolled_at:
          type: string
          format: date-time
          description: When the customer entered this campaign
        audience_status:
          type: string
          description: >-
            Raw campaign-audience status (`COMPLETED`, `IN_PROGRESS`, `FAILED`,
            …)
        dial_attempts:
          type: integer
          description: Dials placed to this customer for this campaign inside the window
        first_dial_at:
          type: string
          format: date-time
        last_dial_at:
          type: string
          format: date-time
        ever_answered:
          type: boolean
        ever_reached_voicemail:
          type: boolean
        booked_st_job_ids:
          type: array
          items:
            type: string
          description: Distinct ServiceTitan jobs booked on those dials
    CursorPagination:
      type: object
      properties:
        cursor:
          type:
            - string
            - 'null'
          description: >-
            Pass back as the `cursor` query parameter to fetch the next page;
            `null` on the last page
        has_more:
          type: boolean
        limit:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable description (newer endpoints)
      required:
        - error
  responses:
    BadRequest:
      description: Invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: API key lacks the required permission or team access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key in the format `avoca_<64 hex characters>`

````