> ## 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. # Get pipeline steps > Load the visible cadence schedule, step counts, callback count, and parked-lead count for the Power Dialer workspace. Customer roles: `agency_admin`, `project_user`. Required API key scope: `power_dialer:read`. ## OpenAPI ````yaml /openapi.yaml get /api/power-dialer/pipeline/steps 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/steps: get: tags: - Power Dialer summary: Get pipeline steps description: >- Load the visible cadence schedule, step counts, callback count, and parked-lead count for the Power Dialer workspace. Customer roles: `agency_admin`, `project_user`. Required API key scope: `power_dialer:read`. operationId: get-pipeline-steps parameters: - name: locationId in: query required: false schema: type: string description: Project location id used to scope the cadence schedule. example: loc_9f7a123 - name: leadLocationId in: query required: false schema: type: string description: >- Optional lead location override. Use `__all__` to include every linked subaccount the caller can access. example: __all__ - name: campaignId in: query required: false schema: type: string description: Campaign id used to scope campaign-bound cadence editing. 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: Power Dialer cadence columns and counts. content: application/json: schema: $ref: '#/components/schemas/PowerDialerPipelineStepsResponse' examples: default: value: success: true data: stepCounts: - cadenceStep: 0 count: 4 cadences: - _id: cadence_123 cadenceName: Three-touch follow-up isDefault: false locationIds: - loc_9f7a123 campaignIds: - campaign_speed_to_lead_123 activeDays: - 1 - 2 - 3 - 4 - 5 active: true schedule: - day: 1 hour: 9 minute: 30 period: AM doubleDial: true call: enabled: true additionalActions: - type: sms body: >- Hi Alex, are you still interested in booking a consultation? delaySeconds: 0 jitterSeconds: 60 createdAt: '2026-07-08T16:10:00.000Z' updatedAt: '2026-07-08T16:30:00.000Z' headers: - stepIndex: 0 label: Day 1, 9:30 AM day: 1 time: 9:30 AM pdOverCount: 2 callbacksCount: 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/steps \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: PowerDialerPipelineStepsResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/PowerDialerPipelineStepsData' 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 PowerDialerPipelineStepsData: type: object additionalProperties: false required: - stepCounts - cadences - pdOverCount - callbacksCount properties: stepCounts: type: array items: $ref: '#/components/schemas/PowerDialerStepCount' cadences: type: array items: $ref: '#/components/schemas/PowerDialerCadenceWithHeaders' pdOverCount: type: integer example: 2 callbacksCount: type: integer example: 1 PowerDialerStepCount: type: object additionalProperties: false required: - cadenceStep - count properties: cadenceStep: type: integer example: 0 count: type: integer example: 4 PowerDialerCadenceWithHeaders: allOf: - $ref: '#/components/schemas/PowerDialerCadence' - type: object additionalProperties: {} required: - headers properties: headers: type: array items: $ref: '#/components/schemas/PowerDialerColumnHeader' PowerDialerCadence: type: object additionalProperties: {} required: - _id - cadenceName - isDefault - locationIds - campaignIds - activeDays - active - schedule properties: _id: type: string example: cadence_123 cadenceName: type: string example: Three-touch follow-up isDefault: type: boolean example: false locationIds: type: array items: type: string example: - loc_9f7a123 campaignIds: type: array items: type: string example: - campaign_speed_to_lead_123 activeDays: type: array items: type: integer minimum: 0 maximum: 6 example: - 1 - 2 - 3 - 4 - 5 active: type: boolean example: true stepCount: type: integer minimum: 0 description: Number of touchpoints in the schedule. example: 3 schedule: type: array items: $ref: '#/components/schemas/PowerDialerScheduleEntry' mode: type: string enum: - appointment_reminder example: appointment_reminder createdAt: type: - string - 'null' format: date-time example: '2026-07-08T16:10:00.000Z' updatedAt: type: - string - 'null' format: date-time example: '2026-07-08T16:30:00.000Z' PowerDialerColumnHeader: type: object additionalProperties: false required: - stepIndex - label - day - time properties: stepIndex: type: integer example: 0 label: type: string example: Day 1, 9:30 AM day: type: integer example: 1 time: type: string example: 9:30 AM PowerDialerScheduleEntry: oneOf: - $ref: '#/components/schemas/PowerDialerScheduleForwardEntry' - $ref: '#/components/schemas/PowerDialerScheduleReminderEntry' description: >- A single touchpoint in a cadence. Forward cadences use clock-time entries (PowerDialerScheduleForwardEntry); appointment_reminder cadences use appointment-anchored entries (PowerDialerScheduleReminderEntry). PowerDialerScheduleForwardEntry: type: object additionalProperties: {} required: - day - hour - minute description: 'A clock-time touchpoint: dial on a given weekday at a given time.' properties: day: type: integer minimum: 0 example: 1 hour: type: integer minimum: 1 maximum: 12 example: 9 minute: type: integer minimum: 0 maximum: 59 example: 30 period: type: string enum: - AM - PM description: AM or PM. Defaults to AM when omitted. example: AM doubleDial: type: boolean example: true call: type: object additionalProperties: false properties: enabled: type: boolean example: true additionalActions: type: array items: $ref: '#/components/schemas/PowerDialerScheduleAction' PowerDialerScheduleReminderEntry: type: object additionalProperties: {} required: - minutesBeforeAppt description: >- An appointment-anchored touchpoint for an appointment_reminder cadence: dial a fixed lead time before the booked appointment. Send minutesBeforeAppt; hoursBeforeAppt and daysBeforeAppt are also accepted and folded into minutes. Do not send day/hour/period. properties: minutesBeforeAppt: type: integer minimum: 1 example: 1440 doubleDial: type: boolean example: true call: type: object additionalProperties: false properties: enabled: type: boolean example: true additionalActions: type: array items: $ref: '#/components/schemas/PowerDialerScheduleAction' PowerDialerScheduleAction: type: object additionalProperties: {} required: - type description: >- A side effect the dialer runs when a touchpoint advances on no outcome, whether the call was unanswered or answered without an actionable outcome. `sms`/`email` carry exactly one of `body`/`snippetId`; `add-tag` carries `tags`; `move-stage` carries `pipelineId`+`stageId`. properties: type: type: string enum: - sms - email - add-tag - move-stage example: sms body: type: string example: Hi Alex, are you still interested in booking a consultation? snippetId: type: string example: snippet_follow_up_1 subject: type: string example: Following up tags: type: array items: type: string description: Tags applied to the contact (add-tag actions). example: - no-answer-followup pipelineId: type: string description: Target pipeline id (move-stage actions). example: pipeline_123 stageId: type: string description: Target stage id (move-stage actions). example: stage_456 delaySeconds: type: integer minimum: 0 example: 0 jitterSeconds: type: integer minimum: 0 example: 60 securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````