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

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, calls, campaigns, contacts, phone numbers, billing, and configuration.

# List callback leads

> List callback leads waiting for their promised callback time. Customer roles: `agency_admin`, `project_user`.

Required API key scope: `power_dialer:read`.



## OpenAPI

````yaml /openapi.yaml get /api/power-dialer/pipeline/callbacks
openapi: 3.1.0
info:
  title: TFUAI Server API
  version: 1.0.0
  description: >-
    API reference for the TFUAI SaaS server.


    All published endpoints are mounted under `/api`. Responses use a standard
    envelope: `{ "success": true, ... }` on success and `{ "success": false,
    "error": "..." }` on failure.


    Product API modules are being launched module by module. This spec currently
    exposes only contracted public modules.


    Authenticate public API requests with an API key in the `Authorization`
    header: `Authorization: Bearer YOUR_API_KEY`.
servers:
  - url: https://api.teamfollowup.ai
    description: Production API origin. Public API paths are under /api.
  - url: https://devapi.teamfollowup.ai
    description: Development API origin. Public API paths are under /api.
security: []
tags:
  - name: Agents
    description: Manage voice agents, campaigns, workflows, and outcomes.
  - name: Analytics
    description: >-
      Minimal, non-billing performance summary: volume, conversion, and pickup
      metrics.
  - name: Calls
    description: Review calls, test runs, and execution history.
  - name: Campaign Workflows
    description: >-
      What runs after a call lands: for each outcome (booked, opted out, asked
      for a callback…), an ordered chain of actions — tag the contact, move a
      pipeline stage, send an SMS, book an appointment. Stored as a graph:
      `nodes` are the actions, `edges` say what follows what, and
      `dispositionEntries` maps each outcome to the node its chain starts at.


      **Pick the narrowest endpoint that does the job.**


      | To | Call | |

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

      | See what fires per outcome | `GET .../workflow/digest` | Reads as plain
      text, no graph walking |

      | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server
      derives node ids, edge ids, handles, layout |

      | Change a message, tag or setting | `PATCH .../workflow` | Merges;
      carries no graph, so it cannot damage one |

      | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain
      around it |

      | Author or replace the whole graph | `PUT .../workflow` | Replaces
      everything you send |


      `PUT` is the only one that can re-wire, position nodes, build an `if`,
      save an unconfigured draft, or copy a whole workflow — and the only one
      that can overwrite a change someone else made after you read it. Use it
      when you are genuinely authoring the graph, and send `expectedVersion`
      when you do. For everything else the narrower endpoints are both easier
      and safer.
  - name: Contacts
    description: Contact list, filters, contact call history, and do-not-call actions.
  - name: GHL
    description: CRM variables and contact helpers used by agent and campaign setup flows.
  - name: Phone Numbers
    description: >-
      Caller ID pool, number search, assignment, movement, and release
      endpoints.
  - name: Power Dialer
    description: >-
      Power Dialer queue, lead cadence, callback, parked lead, and campaign
      schedule endpoints.
  - name: Projects
    description: >-
      Project management endpoints: list, update, disconnect, configure project
      campaigns, and validate setup.
  - name: Skills and Tools
    description: Manage reusable agent behaviors and in-call tool descriptions.
  - name: Voices
    description: Voice catalogue endpoints for choosing the voice used by an agent.
paths:
  /api/power-dialer/pipeline/callbacks:
    get:
      tags:
        - Power Dialer
      summary: List callback leads
      description: >-
        List callback leads waiting for their promised callback time. Customer
        roles: `agency_admin`, `project_user`.


        Required API key scope: `power_dialer:read`.
      operationId: list-callback-leads
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: Page number.
          example: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Page size. Maximum 100.
          example: 20
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Case-insensitive lead search.
          example: Alex
        - name: locationId
          in: query
          required: false
          schema:
            type: string
          description: >-
            Limit results to one project location id. The caller must have
            access to the project.
          example: loc_9f7a123
        - name: campaignId
          in: query
          required: false
          schema:
            type: string
          description: Limit results to one campaign id.
          example: campaign_speed_to_lead_123
        - name: campaignIds
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated campaign ids for combined campaign views.
          example: campaign_speed_to_lead_123,campaign_reactivation_123
      responses:
        '200':
          description: Paginated callback leads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerPagedLeadsResponse'
              examples:
                default:
                  value:
                    success: true
                    data:
                      leads:
                        - _id: 64f2a8c8a2b3c4d5e6f7a8b9
                          queueId: queue_123
                          cadenceStep: 0
                          callStatus: scheduled
                          nextCallTime: '2026-07-08T17:00:00.000Z'
                          timezone: America/New_York
                          firstName: Alex
                          fullName: Alex Morgan
                          email: alex@example.test
                          phone: '+14155551234'
                          live: false
                          callerPreference: morning
                          createdAt: '2026-07-08T16:00:00.000Z'
                          tags:
                            - new_lead
                          locationId: loc_9f7a123
                          businessName: Acme Clinic
                          pipeline: v2
                          campaignId: campaign_speed_to_lead_123
                          campaignName: Speed to Lead
                          callback: true
                          callbackRequestedAt: '2026-07-08T16:15:00.000Z'
                      total: 1
                      page: 1
                      totalPages: 1
        '400':
          description: Validation failed or the request is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: cadenceStep query parameter is required
        '401':
          description: Missing or invalid authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unauthorized
        '403':
          description: >-
            Authenticated but not permitted to access the requested project or
            schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: You do not have access to this project
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: TooManyRequests
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerDialerErrorResponse'
              examples:
                default:
                  value:
                    success: false
                    error: Unexpected server error.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --request GET \
              --url https://api.teamfollowup.ai/api/power-dialer/pipeline/callbacks \
              --header 'Authorization: Bearer YOUR_API_KEY'
components:
  schemas:
    PowerDialerPagedLeadsResponse:
      type: object
      additionalProperties: false
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/PowerDialerPagedLeadsData'
    PowerDialerErrorResponse:
      type: object
      additionalProperties: {}
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        error:
          type: string
          example: You do not have access to this project
        code:
          type: string
          example: FORBIDDEN
        message:
          type: string
          example: You do not have access to this project
    PowerDialerPagedLeadsData:
      type: object
      additionalProperties: false
      required:
        - leads
        - total
        - page
        - totalPages
      properties:
        leads:
          type: array
          items:
            $ref: '#/components/schemas/PowerDialerQueueLead'
        total:
          type: integer
          example: 1
        page:
          type: integer
          example: 1
        totalPages:
          type: integer
          example: 1
    PowerDialerQueueLead:
      type: object
      additionalProperties: {}
      required:
        - queueId
        - callStatus
        - live
        - tags
      properties:
        _id:
          type: string
          example: 64f2a8c8a2b3c4d5e6f7a8b9
        queueId:
          type: string
          example: queue_123
        cadenceStep:
          type:
            - integer
            - 'null'
          example: 0
        callStatus:
          type: string
          example: scheduled
        nextCallTime:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-08T17:00:00.000Z'
        timezone:
          type:
            - string
            - 'null'
          example: America/New_York
        firstName:
          type:
            - string
            - 'null'
          example: Alex
        fullName:
          type:
            - string
            - 'null'
          example: Alex Morgan
        email:
          type:
            - string
            - 'null'
          example: alex@example.test
        phone:
          type:
            - string
            - 'null'
          example: '+14155551234'
        live:
          type: boolean
          description: Whether the lead is mid-dispatch (dialing now).
          example: true
        callerPreference:
          type:
            - string
            - 'null'
          example: morning
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-08T16:00:00.000Z'
        tags:
          type: array
          items:
            type: string
          example:
            - new_lead
        locationId:
          type:
            - string
            - 'null'
          example: loc_9f7a123
        businessName:
          type:
            - string
            - 'null'
          example: Acme Clinic
        pipeline:
          type: string
          enum:
            - v1
            - v2
          example: v2
        callback:
          type: boolean
          example: true
        callbackRequestedAt:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-08T16:15:00.000Z'
        campaignId:
          type:
            - string
            - 'null'
          example: campaign_speed_to_lead_123
        campaignName:
          type:
            - string
            - 'null'
          example: Speed to Lead
        queue_id:
          type: string
          description: Legacy alias of `queueId`.
          example: queue_123
        first_name:
          type:
            - string
            - 'null'
          description: Legacy alias of `firstName`.
          example: Alex
        full_name:
          type:
            - string
            - 'null'
          description: Legacy alias of `fullName`.
          example: Alex Morgan
        caller_pref:
          type:
            - string
            - 'null'
          description: Legacy alias of `callerPreference`.
          example: morning
        date_created:
          type:
            - string
            - 'null'
          description: Legacy alias of `createdAt`.
          example: '2026-07-08T16:00:00.000Z'
        location_id:
          type:
            - string
            - 'null'
          description: Legacy alias of `locationId`.
          example: loc_9f7a123
        business_name:
          type:
            - string
            - 'null'
          description: Legacy alias of `businessName`.
          example: Acme Clinic
        isLive:
          type: boolean
          description: Legacy alias of `live`.
          example: true
        isCallback:
          type: boolean
          description: Legacy alias of `callback`.
          example: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.'

````