> ## 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 agents > List agents visible to the caller. Agency admins see only agents in their agency. Use cursor pagination for integrations that sync agents repeatedly. Required API key scope: `agents:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/agents 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: get: tags: - Agents summary: List agents description: >- List agents visible to the caller. Agency admins see only agents in their agency. Use cursor pagination for integrations that sync agents repeatedly. Required API key scope: `agents:read`. operationId: get-agent-builder-agents parameters: - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 500 default: 500 description: Maximum agents to return. - name: cursor in: query required: false schema: type: string minLength: 1 description: Cursor returned by the previous response. - name: agentType in: query required: false schema: type: string enum: - outreach - inbound - appointment description: >- Filter to agents bound to campaigns of this campaign type. An unrecognised value is rejected with a 400. example: outreach - name: locationId in: query required: false schema: type: string minLength: 1 description: Filter to agents bound to campaigns in one project location. example: loc_abc123 - name: q in: query required: false schema: type: string minLength: 1 description: Case-insensitive name search. example: roofing - name: sort in: query required: false schema: type: string enum: - updatedAt.desc - createdAt.desc default: updatedAt.desc description: Sort order for the page. responses: '200': description: Visible builder agents. content: application/json: schema: $ref: '#/components/schemas/AgentsListAgentsResponse' examples: default: value: success: true agents: - id: agent_1ffdb9717444d0e77346838911 agentType: outreach name: Roofing Follow Up active: true createdAt: '2026-07-08T10:00:00.000Z' updatedAt: '2026-07-08T10:00:00.000Z' campaign: id: cmp_123 name: Roofing Follow Up agentType: outreach capabilities: - live_transfer - add_tag dialing: s2l_pd active: true locationId: loc_abc123 projectName: Acme Roofing businessName: Acme Roofing agencyName: Acme Agency agentName: Roofing Follow Up hasMore: false nextCursor: null '400': description: Validation failed or the request body is malformed. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: VALIDATION message: Invalid request. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: >- Authenticated but missing the required `agents:read` scope or tenant access. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' examples: default: value: success: false error: FORBIDDEN message: No access to agent "agent_1ffdb9717444d0e77346838911". insufficientScope: value: success: false error: InsufficientScope message: This API key does not have the required scope. requiredScope: agents:read '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/AgentsErrorResponse' 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/AgentsErrorResponse' 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 \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: AgentsListAgentsResponse: type: object additionalProperties: false required: - success - agents properties: success: type: boolean agents: type: array items: $ref: '#/components/schemas/AgentsAgentSummary' hasMore: type: boolean description: True when another page is available. example: false nextCursor: type: - string - 'null' description: Cursor to pass to the next List agents request. example: null AgentsErrorResponse: 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: locationId is required. references: type: object additionalProperties: {} description: Structured conflict details. Present on delete conflicts. details: type: array description: Field-level validation details when available. items: type: object additionalProperties: false required: - field - message properties: field: type: - string - 'null' example: locationId message: type: string example: locationId is required. AgentsAgentSummary: type: object additionalProperties: {} required: - id - agentType - name description: >- Lightweight agent projection for the list endpoint: the canonical agent shape without the heavy config. properties: id: type: string example: agent_1ffdb9717444d0e77346838911 agentId: type: string description: >- Same value as `id`, emitted for callers that key on the agent id explicitly. example: agent_1ffdb9717444d0e77346838911 agentType: type: - string - 'null' enum: - outreach - inbound - appointment - null description: >- Campaign type this agent was created as. Null when no recognised type can be resolved from the agent or its campaign. example: outreach name: type: string example: Roofing Follow Up active: type: boolean description: >- The agent's live state, driven by its primary campaign switch. Note the spelling: this endpoint returns `active`, while Get agent returns the same state as `isActive`. Emitted only when the primary campaign row carries the flag. example: true createdAt: type: string format: date-time updatedAt: type: string format: date-time campaign: $ref: '#/components/schemas/AgentsAgentSummaryCampaign' AgentsAgentSummaryCampaign: type: object additionalProperties: {} required: - id - name properties: id: type: string example: cmp_123 name: type: string example: Roofing Follow Up agentId: type: string example: agent_1ffdb9717444d0e77346838911 agentType: type: - string - 'null' enum: - outreach - inbound - appointment - null description: >- Campaign type for this binding. Null when the binding carries no recognised type. example: outreach capabilities: type: array items: type: string enum: - appointment_booking - live_transfer - add_tag description: >- Behaviours installed on this campaign. Each capability installs its own in-call tool(s), post-call fields, workflow route, required configuration, AND the prompt section telling the agent how to use it — added and removed as one unit. Changing this list rebuilds the agent's objective prompt from the campaign type plus the remaining capabilities; the operator-authored part of the prompt is never touched. Capabilities also gate the outcomes a call can end in: `TRANSFER` requires `live_transfer`, and `SUCCESS`/`RESCHEDULE` require `appointment_booking`. example: - live_transfer - add_tag dialing: type: - string - 'null' enum: - s2l - pd - s2l_pd - reactivation - null description: Dispatch mode of the bound campaign. example: s2l_pd active: type: boolean description: Whether the bound campaign is live. example: true locationId: type: - string - 'null' example: loc_abc123 projectName: type: - string - 'null' example: Acme Roofing businessName: type: - string - 'null' description: Visible project business name for this campaign binding. example: Acme Roofing agencyName: type: - string - 'null' description: Visible agency name for this campaign binding. example: Acme Agency agentName: type: - string - 'null' description: Display name of the bound agent. example: Roofing Front Desk Agent securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````