> ## 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, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers. > Scope requests by locationId rather than projectName. > Read the guide linked from each API reference group before recommending an endpoint. # List campaign runs > Recent execution history for this agent's campaign: one row per processed call — who was called, when, the outcome the call reached, and whether the post-call workflow succeeded — plus the leads still queued for a future dial. This is not `GET /api/call-history`, which lists calls; a run is a call plus what the workflow did with it. Filter by `name` or `phone` to answer questions about one lead. Customer role: `agency_admin`. Required API key scope: `calls:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/agents/{id}/campaign/runs 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. security: [] tags: - name: Agents description: >- Build the conversation: identity and settings, script, lead context and split testing. - name: Analytics description: >- Understand call volume, pickup, booking and transfer metrics within the selected reporting scope. - name: Billing description: >- Balances, spend, purchases and sub-account rebilling. Reference and guides only; the builder chatbot has no billing playbook. - name: Calls description: >- Review completed calls, recordings, transcripts and campaign run history; distinguish observation from placing a new call. - name: Campaigns description: >- Configure what starts calls, who is eligible, calling windows, caller IDs, activation and the actions that follow each outcome. 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?view=summary` | 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: >- Find contacts and their calls, manage do-not-call status and identify internal contacts excluded from reporting. - name: In-call Capabilities description: >- Configure actions and instructions the agent uses during a live call: booking, transfers, lookups and custom skills. - name: Master agent description: >- Run a shared agent and campaign across linked projects; manage inheritance, local bindings, synchronization and rollout readiness. - name: Native Calendar description: >- The diary of a sub-account with no CRM: its bookable calendars, the free slots they offer, and the appointments on them. Availability is computed per request against live bookings and is never cached, because a cached slot is one somebody else has already taken. - name: Native Contacts description: >- The people a sub-account with no CRM calls, and the fields it keeps on them. This is the system of record for those contacts: there is nowhere else they exist. A sub-account with a CRM keeps its contacts there and every operation here answers 400 for it. - name: Phone Numbers description: >- Find and manage caller IDs, assign numbers to campaigns and understand connected Twilio numbers. - name: Projects description: >- Understand project ownership, inspect configuration and validate the local resources used by a campaign. - name: TFU Live description: >- Build one TFU Live agent with its Brain, Voice and equipped actions; connect it through shared Campaigns. - name: Voices description: >- Browse the voice catalogue and select a voice; configure speech and listening behavior in Agents. paths: /api/agent-builder/agents/{id}/campaign/runs: get: tags: - Campaigns summary: List campaign runs description: >- Recent execution history for this agent's campaign: one row per processed call — who was called, when, the outcome the call reached, and whether the post-call workflow succeeded — plus the leads still queued for a future dial. This is not `GET /api/call-history`, which lists calls; a run is a call plus what the workflow did with it. Filter by `name` or `phone` to answer questions about one lead. Customer role: `agency_admin`. Required API key scope: `calls:read`. operationId: list-campaign-runs parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id returned by the Agents API. example: agent_8a488fcfa8fdbf8ce8ad5ccc45 - name: locationId in: query required: false schema: type: string minLength: 1 description: Pair with campaignId; omit both for primary campaign. example: loc_abc123 - name: campaignId in: query required: false schema: type: string minLength: 1 description: Pair with locationId; omit both for primary campaign. example: cmp_123 - name: contactId in: query required: false schema: type: string description: Filter by contact id. example: contact_123 - name: phone in: query required: false schema: type: string description: Filter by lead phone number. example: '+14155559876' - name: name in: query required: false schema: type: string description: Filter by lead name. example: Alex - name: dateFrom in: query required: false schema: type: string description: >- Inclusive start of the run-start-time window. A UTC ISO 8601 timestamp is canonical; a plain `YYYY-MM-DD` date is accepted and read as that day at 00:00:00Z. A timestamp must carry `Z` or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. example: '2026-07-01' - name: dateTo in: query required: false schema: type: string description: >- Inclusive end of the run-start-time window. A UTC ISO 8601 timestamp is canonical; a plain `YYYY-MM-DD` date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry `Z` or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. example: '2026-07-08' - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 description: Maximum number of runs to return. example: 50 responses: '200': description: Recent runs and upcoming scheduled dials. content: application/json: schema: $ref: '#/components/schemas/CallsExecutionRunsResponse' examples: default: value: success: true data: runs: - lifecycleId: life_2b7c9f4a callId: call_123 contactId: contact_123 leadName: Alex Morgan leadSnapshot: contactId: contact_123 name: Alex Morgan phone: '+14155559876' email: alex@example.test phone: '+14155559876' phase: post_call status: ok disposition: CALLBACK hasError: false displayError: null stepCount: 3 startedAt: '2026-07-08T16:30:00.000Z' - lifecycleId: life_7c1a4e93 callId: call_456 contactId: contact_789 leadName: Dana Whitfield leadSnapshot: contactId: contact_789 name: Dana Whitfield phone: '+14155550188' phone: '+14155550188' phase: post_call status: error disposition: SUCCESS hasError: true displayError: This step failed while processing. stepCount: 4 startedAt: '2026-07-08T15:05:00.000Z' scheduled: - lifecycleId: life_9d2e4c1b contactId: contact_456 leadName: Rosa Castellano leadSnapshot: contactId: contact_456 name: Rosa Castellano phone: '+14155550121' phone: '+14155550121' phase: scheduled status: scheduled attempt: 2 attemptTotal: 5 isTest: false nextCallTime: '2026-07-09T15:30:00.000Z' '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: VALIDATION message: A required value is missing. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to access the requested resource. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have access to this project. '404': description: Resource not found or not visible to the caller. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: NotFound message: Call not found or access denied. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: TooManyRequests message: Too many requests, please try again later. '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: InternalError message: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/runs \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: CallsExecutionRunsResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/CallsExecutionRuns' CallsErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: Machine-readable error code. example: VALIDATION message: type: string description: Human-readable explanation safe to show to an operator. example: A required value is missing. CallsExecutionRuns: type: object additionalProperties: false required: - runs properties: runs: type: array description: >- Processed runs, most recent first. One row per call that has been through the post-call workflow. items: $ref: '#/components/schemas/CallsExecutionRunSummary' scheduled: type: array description: >- Leads queued for a future dial. Absent when a date filter is applied, because a scheduled lead has not run. items: $ref: '#/components/schemas/CallsExecutionScheduledRun' CallsExecutionRunSummary: type: object additionalProperties: false required: - lifecycleId - callId - phase - status - hasError - stepCount properties: lifecycleId: type: - string - 'null' example: life_2b7c9f4a callId: type: - string - 'null' description: Fallback call identity when a lifecycle id was not recorded. example: call_123 contactId: type: - string - 'null' example: contact_123 leadName: type: - string - 'null' example: Alex Morgan leadSnapshot: anyOf: - $ref: '#/components/schemas/CallsExecutionLeadSnapshot' - type: 'null' phone: type: - string - 'null' example: '+14155559876' phase: type: string example: post_call status: type: string example: ok disposition: type: - string - 'null' example: CALLBACK hasError: type: boolean example: false displayError: type: - string - 'null' example: null stepCount: type: integer example: 3 startedAt: type: - string - 'null' format: date-time example: '2026-07-08T16:30:00.000Z' CallsExecutionScheduledRun: type: object additionalProperties: false required: - lifecycleId - phase - status - isTest properties: lifecycleId: type: - string - 'null' example: life_9d2e4c1b contactId: type: - string - 'null' example: contact_456 leadName: type: - string - 'null' example: Rosa Castellano leadSnapshot: anyOf: - $ref: '#/components/schemas/CallsExecutionLeadSnapshot' - type: 'null' phone: type: - string - 'null' example: '+14155550121' phase: type: string enum: - scheduled example: scheduled status: type: string enum: - scheduled example: scheduled attempt: type: - integer - 'null' description: Cadence attempt this dial will be, counting from 1. example: 2 attemptTotal: type: - integer - 'null' description: Total steps in the cadence, when it is readable. example: 5 isTest: type: boolean example: false nextCallTime: type: - string - 'null' format: date-time example: '2026-07-09T15:30:00.000Z' CallsExecutionLeadSnapshot: type: object additionalProperties: false properties: contactId: type: string example: contact_123 name: type: string example: Alex Morgan firstName: type: string example: Alex lastName: type: string example: Morgan phone: type: string example: '+14155559876' email: type: string example: alex@example.test securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````