> ## 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 phone numbers > List the agency phone number pool and the campaigns currently using each caller ID. Allowed customer role: `agency_admin`. An agency admin is scoped to their own agency and needs no parameter. A staff credential has no implicit agency, so it must name one with `agencyTag`; without it the response is an empty pool carrying `needsAgency: true`, which means "choose an agency", not "this agency owns no numbers". Required API key scope: `phone_numbers:read`. ## OpenAPI ````yaml /openapi.yaml get /api/agent-builder/phone-numbers 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/phone-numbers: get: tags: - Phone Numbers summary: List phone numbers description: >- List the agency phone number pool and the campaigns currently using each caller ID. Allowed customer role: `agency_admin`. An agency admin is scoped to their own agency and needs no parameter. A staff credential has no implicit agency, so it must name one with `agencyTag`; without it the response is an empty pool carrying `needsAgency: true`, which means "choose an agency", not "this agency owns no numbers". Required API key scope: `phone_numbers:read`. operationId: get-agent-builder-phone-numbers parameters: - name: agencyTag in: query required: false schema: type: string minLength: 1 description: >- Agency whose pool to list. Ignored for an agency admin, who is always scoped to their own agency. Required for a staff credential, which has no implicit agency. example: acme-agency responses: '200': description: Agency phone number pool. content: application/json: schema: $ref: '#/components/schemas/PhoneNumbersAgencyListResponse' examples: default: value: success: true phoneNumbers: - phoneNumber: '+14155551234' pretty: +1 (415) 555-1234 campaigns: - campaignId: campaign_speed_to_lead_123 name: Speed to Lead locationId: loc_9f7a123 projectName: Acme Clinic agentId: agent_2b7c9f4a agentName: Front Desk Agent active: true isActive: true needsAgency: false '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/PhoneNumbersErrorResponse' examples: default: value: success: false error: VALIDATION message: A campaignId is required. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/PhoneNumbersErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to manage phone numbers. content: application/json: schema: $ref: '#/components/schemas/PhoneNumbersErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have access to phone number endpoints. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/PhoneNumbersErrorResponse' 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/PhoneNumbersErrorResponse' 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/phone-numbers \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: PhoneNumbersAgencyListResponse: type: object additionalProperties: false required: - success - phoneNumbers - needsAgency properties: success: type: boolean phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumbersAgencyPhoneNumber' needsAgency: type: boolean description: >- Whether the request needs an agency context before results can be returned. example: false PhoneNumbersErrorResponse: type: object additionalProperties: {} required: - success - error - message properties: success: type: boolean error: type: string description: Machine-readable error code. example: CONFLICT message: type: string description: Human-readable explanation safe to show to an operator. example: >- This is the only number on an active campaign. Pause the campaign or add another number before removing it. PhoneNumbersAgencyPhoneNumber: type: object additionalProperties: false required: - phoneNumber - pretty - campaigns properties: phoneNumber: type: string pattern: ^\+\d{10,15}$ description: E.164 caller ID. example: '+14155551234' pretty: type: - string - 'null' description: Display label for the phone number. example: +1 (415) 555-1234 campaigns: type: array description: Campaigns currently using this caller ID. items: $ref: '#/components/schemas/PhoneNumbersCampaignRef' PhoneNumbersCampaignRef: type: object additionalProperties: false required: - campaignId - name - locationId - projectName - agentId - agentName - active properties: campaignId: type: string example: campaign_speed_to_lead_123 name: type: string example: Speed to Lead locationId: type: - string - 'null' description: Project location id that owns the campaign. example: loc_9f7a123 projectName: type: - string - 'null' description: Project display name. example: Acme Clinic agentId: type: - string - 'null' description: Agent id assigned to the campaign. example: agent_2b7c9f4a agentName: type: - string - 'null' description: Agent display name. example: Front Desk Agent active: type: boolean description: Whether the campaign is active (live). example: true isActive: type: boolean deprecated: true description: >- Deprecated legacy alias for `active`, echoed during the migration window. Use `active`. example: true securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````