> ## 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 contacts > Authentication required. Intended for customer-facing agency administrators and project users. Results and actions are tenant-scoped to projects visible to the caller. Returns unique contacts with pagination, scheduled follow-up state, and most recent outcome. Required API key scope: `contacts:read`. ## OpenAPI ````yaml /openapi.yaml get /api/contacts 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/contacts: get: tags: - Contacts summary: List contacts description: >- Authentication required. Intended for customer-facing agency administrators and project users. Results and actions are tenant-scoped to projects visible to the caller. Returns unique contacts with pagination, scheduled follow-up state, and most recent outcome. Required API key scope: `contacts:read`. operationId: list-contacts parameters: - name: projectName in: query required: false schema: type: string description: Restrict results to one project visible to the caller. example: Acme Clinic - name: locationId in: query required: false schema: type: string description: >- Restrict results to one project by its stable location id. Preferred over projectName, which is not stable across renames. example: loc_9f7a123 - name: campaignId in: query required: false schema: type: string description: >- Restrict results to the leads one campaign dialled. Resolved against call records, so the count matches the campaign figures on the dashboard. Only V2 activity carries campaign attribution. example: cmp_9f7a123 - name: masterCampaignId in: query required: false schema: type: string description: >- Restrict results to the leads an entire master campaign dialled, across every linked project the caller can see. A master campaign is fanned out into one child campaign per project, each with its own id, so filtering by a single campaignId returns one project's share of it. Mutually exclusive with campaignId: the two are contradictory scopes rather than narrowing ones, and sending both is a 400. example: mc_84f1be18-2329-4af1-a2f0-abcf2170aba9 - name: projects in: query required: false schema: type: string description: Comma-separated project names for agency-level filtering. example: Acme Clinic,North Office - name: search in: query required: false schema: type: string description: Search by contact name, phone number, or contact id. example: Alex - name: dateFromUTC in: query required: false schema: type: string format: date-time description: Inclusive UTC lower bound for contact creation time. example: '2026-07-01T00:00:00.000Z' - name: dateToUTC in: query required: false schema: type: string format: date-time description: Inclusive UTC upper bound for contact creation time. example: '2026-07-08T23:59:59.999Z' - name: disposition in: query required: false schema: type: array items: type: string enum: - killSwitch - callBack - appointment - liveTransfer - failedTransfer - tagged description: >- Outcome filter. Send it repeated (`disposition=appointment&disposition=callBack`) or comma-joined (`appointment,callBack`) to match several. example: - appointment - callBack - name: internal in: query required: false schema: type: string enum: - all - only - exclude description: >- How to treat contacts marked as your own test leads. `all` (the default) lists them alongside everything else with `isInternal` set on each row, `only` narrows to just those, `exclude` hides them. They are listed by default because hiding them would leave no way to find one and undo the mark. example: all - name: page in: query required: false schema: type: integer minimum: 1 description: Page number, starting at 1. example: 1 - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 500 description: Contacts per page. example: 50 - name: sortBy in: query required: false schema: type: string enum: - leadName - phoneNumber - projectName - dateAdded - callCount description: Sort field. example: dateAdded - name: sortOrder in: query required: false schema: type: string enum: - asc - desc description: Sort direction. example: desc responses: '200': description: Contacts page returned successfully. content: application/json: schema: $ref: '#/components/schemas/ContactsListResponse' examples: default: value: success: true data: contacts: - id: 64f2a8c8a2b3c4d5e6f7a8b9 _id: 64f2a8c8a2b3c4d5e6f7a8b9 phoneNumber: '+14155551234' leadName: Alex Morgan projectName: Acme Clinic dateAdded: '2026-07-08T16:00:00.000Z' callCount: 3 contactId: contact_123 locationId: loc_9f7a123 crm: ghl leadId: null kommoSubdomain: null ghlWhitelabelDomain: null isInternal: false nextScheduledCall: nextCallTime: '2026-07-09T14:30:00.000Z' cadenceStep: 1 disposition: type: appointment label: Appointment color: green pagination: page: 1 limit: 50 total: 1 totalPages: 1 '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/ContactsErrorResponse' examples: default: value: success: false error: projectName is required '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/ContactsErrorResponse' examples: default: value: success: false error: Unauthorized '403': description: Authenticated but not permitted to access the requested project. content: application/json: schema: $ref: '#/components/schemas/ContactsErrorResponse' examples: default: value: success: false error: Access denied to this project '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ContactsErrorResponse' examples: default: value: success: false error: TooManyRequests '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ContactsErrorResponse' examples: default: value: success: false error: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/contacts \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: ContactsListResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/ContactsListData' ContactsErrorResponse: type: object additionalProperties: {} required: - success - error properties: success: type: boolean error: type: string example: Access denied to this project code: type: string example: FORBIDDEN message: type: string example: Access denied to this project ContactsListData: type: object additionalProperties: false required: - contacts - pagination properties: contacts: type: array items: $ref: '#/components/schemas/ContactsContact' pagination: $ref: '#/components/schemas/ContactsPagination' ContactsContact: type: object additionalProperties: false required: - id - phoneNumber - leadName - projectName - dateAdded - callCount - contactId - locationId - crm - leadId - kommoSubdomain - ghlWhitelabelDomain - isInternal - nextScheduledCall - disposition properties: id: type: string example: 64f2a8c8a2b3c4d5e6f7a8b9 _id: type: string description: Legacy alias of `id`. example: 64f2a8c8a2b3c4d5e6f7a8b9 phoneNumber: type: string example: '+14155551234' leadName: type: - string - 'null' example: Alex Morgan projectName: type: string example: Acme Clinic dateAdded: type: - string - 'null' format: date-time example: '2026-07-08T16:00:00.000Z' callCount: type: integer minimum: 0 example: 3 contactId: type: - string - 'null' example: contact_123 locationId: type: - string - 'null' description: CRM location id used to build the contact deep link. example: loc_9f7a123 crm: type: - string - 'null' description: CRM provider for this contact ('ghl' or 'kommo'). example: ghl leadId: type: - string - 'null' description: CRM lead id (Kommo). Null for GHL contacts. example: null kommoSubdomain: type: - string - 'null' description: Kommo tenant subdomain used to build the Kommo deep link. example: null ghlWhitelabelDomain: type: - string - 'null' description: >- Host serving the agency's white-labelled GoHighLevel (e.g. 'app.example.com'). Null when the agency uses the shared default host. example: null isInternal: type: boolean description: >- True when this contact is marked as one of your own test leads, Its calls are left out of the dashboard's performance figures but kept in the cost figures. example: false nextScheduledCall: anyOf: - $ref: '#/components/schemas/ContactsScheduledCall' - type: 'null' disposition: anyOf: - $ref: '#/components/schemas/ContactsOutcome' - type: 'null' ContactsPagination: type: object additionalProperties: false required: - page - limit - total - totalPages properties: page: type: integer minimum: 1 example: 1 limit: type: integer minimum: 1 example: 50 total: type: integer minimum: 0 example: 1 totalPages: type: integer minimum: 0 example: 1 ContactsScheduledCall: type: object additionalProperties: false required: - nextCallTime - cadenceStep properties: nextCallTime: type: - string - 'null' format: date-time example: '2026-07-09T14:30:00.000Z' cadenceStep: type: - integer - 'null' example: 1 ContactsOutcome: type: object additionalProperties: {} required: - type - label - color properties: type: $ref: '#/components/schemas/ContactsOutcomeType' id: type: string example: disp_123 _id: type: string description: Legacy alias of `id`. example: disp_123 label: type: string example: Appointment color: type: string example: green date: type: string example: '2026-07-08T16:15:00.000Z' duration: type: - number - 'null' example: 184 dateCreated: type: string example: '2026-07-08T16:15:00.000Z' dateScheduled: type: string example: '2026-07-09' requestedDateTime: type: string example: '2026-07-09T15:00:00.000Z' calendarName: type: - string - 'null' example: Main Calendar dateOfAppointment: type: string example: '2026-07-11' timeOfAppointment: type: string example: 10:30 AM dayOfWeek: type: string example: Saturday stageBooked: type: - string - 'null' example: Consultation status: type: string example: Successful ContactsOutcomeType: type: string enum: - killSwitch - callBack - appointment - liveTransfer - failedTransfer - tagged example: appointment securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````