> ## 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. # Read TFU Live master campaign families > Admin read scoped to the sub-account, including API keys/OAuth with campaigns:read. Reads existing masterCampaign parent/child metadata for explicit campaigns sharing one TFU Live profile. A removed or rebound campaign makes the family needs_attention; it never silently joins another agent. Required API key scope: `campaigns:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/projects/{locationId}/tfu-live-families 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/projects/{locationId}/tfu-live-families: get: tags: - TFU Live summary: Read TFU Live master campaign families description: >- Admin read scoped to the sub-account, including API keys/OAuth with campaigns:read. Reads existing masterCampaign parent/child metadata for explicit campaigns sharing one TFU Live profile. A removed or rebound campaign makes the family needs_attention; it never silently joins another agent. Required API key scope: `campaigns:read`. operationId: list_tfu_live_master_families parameters: - name: locationId in: path required: true schema: type: string description: '`locationId` path parameter' responses: '200': description: >- Saved master-family relationship. No campaign or agent settings are copied. content: application/json: schema: $ref: '#/components/schemas/ApiSuccess' type: object properties: success: type: boolean data: type: object properties: families: type: array items: type: object additionalProperties: false required: - profileId - parentCampaignId - campaignIds - version - status properties: profileId: type: string parentCampaignId: type: - string - 'null' campaignIds: type: array items: type: string version: type: integer status: type: string enum: - ready - needs_attention example: success: true data: families: - profileId: live_master parentCampaignId: camp_parent campaignIds: - camp_parent - camp_child version: 1 status: ready '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/agent-builder/projects/{locationId}/tfu-live-families \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: ApiSuccess: type: object description: >- Standard success envelope. The payload key varies by endpoint (`data`, `result`, a named field, etc.). properties: success: type: boolean example: true data: description: Endpoint-specific payload. required: - success ApiError: type: object description: Standard error envelope returned by the API. properties: success: type: boolean example: false error: type: string description: Short machine-readable error code. example: Unauthorized message: type: string description: Human-readable explanation of the error. example: Authentication required. required: - success - error responses: ValidationError: description: Validation failed / malformed request. content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: Authenticated but not permitted (role or tenant scope). content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ApiError' RateLimited: description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ApiError' ServerError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.