> ## 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 a per-outcome workflow digest > **Start here to understand a workflow.** A compact, human-readable summary of what fires for each outcome, plus the AI-notes toggles and a node count. Read this to understand the graph before editing it. Required API key scope: `campaign_workflows:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/agents/{id}/campaign/workflow/digest 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/agent-builder/agents/{id}/campaign/workflow/digest: get: tags: - Campaign Workflows summary: Get a per-outcome workflow digest description: >- **Start here to understand a workflow.** A compact, human-readable summary of what fires for each outcome, plus the AI-notes toggles and a node count. Read this to understand the graph before editing it. Required API key scope: `campaign_workflows:read`. operationId: get-campaign-workflow-digest parameters: - name: id in: path required: true schema: type: string minLength: 1 description: Agent id. example: agent_1ffdb9717444d0e77346838911 - 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 responses: '200': description: Per-outcome digest, or null when no workflow exists. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsDigestResponse' examples: default: value: success: true digest: version: 3 nodeCount: 2 outcomes: SUCCESS: actions: - 'add tag: booked_via_ai' - send SMS branches: false aiNotes: callback: true human_needed: true '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsErrorResponse' examples: default: value: success: false error: VALIDATION message: Workflow graph must have a nodes object. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to access this project. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsErrorResponse' examples: default: value: success: false error: FORBIDDEN message: You do not have access to this project. '404': description: Campaign or workflow not found. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsErrorResponse' examples: default: value: success: false error: NOT_FOUND message: Campaign not found on this project. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/CampaignWorkflowsErrorResponse' examples: default: value: success: false error: RateLimited message: Rate limit exceeded. Retry after a short delay. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/workflow/digest \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: CampaignWorkflowsDigestResponse: type: object additionalProperties: false required: - success - digest properties: success: type: boolean example: true digest: oneOf: - $ref: '#/components/schemas/CampaignWorkflowsDigest' - type: 'null' CampaignWorkflowsErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: >- Machine-readable cause. Prefer branching on the HTTP status: this field spans two producers and is not a single closed set. example: VALIDATION code: type: string example: VALIDATION message: type: string example: Workflow graph must have a nodes object. requiredRole: description: 'Present on a role-based 403: the role the route requires.' example: agency_admin requiredScope: type: string description: 'Present on a scope-based 403: the API-key scope the route requires.' example: campaigns:write CampaignWorkflowsDigest: type: object additionalProperties: false required: - nodeCount - outcomes properties: version: oneOf: - type: integer - type: 'null' example: 3 nodeCount: type: integer example: 4 outcomes: type: object description: >- Per-outcome summary keyed by disposition. Lists the ordered action summaries and any branch tail. additionalProperties: type: object additionalProperties: false properties: actions: type: array items: type: string description: >- Ordered one-line summaries of what fires, in the server's own terse phrasing. example: - 'add tag: hot_lead' - book appointment branches: type: boolean description: >- True when the chain ends in a branch (`if`/`switch`) or a fan-out. Those chains cannot be extended with the append-action endpoint — edit them in the canvas. example: false aiNotes: oneOf: - type: object additionalProperties: type: boolean - type: 'null' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````