> ## 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 calls > List tenant-scoped call records with filtering, sorting, pagination, and viewer-safe cost fields. Customer roles: `agency_admin`, `project_user`. Required API key scope: `calls:read`. ## OpenAPI ````yaml /openapi.yaml get /api/call-history 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/call-history: get: tags: - Calls summary: List calls description: >- List tenant-scoped call records with filtering, sorting, pagination, and viewer-safe cost fields. Customer roles: `agency_admin`, `project_user`. Required API key scope: `calls:read`. operationId: list-calls parameters: - name: projectName in: query required: false schema: type: string description: Filter by project display name. example: Acme Clinic - name: locationId in: query required: false schema: type: string description: >- Filter by project location id. Preferred over projectName: the id is stable across project renames. example: loc_9f7a123 - name: status in: query required: false schema: type: string description: Filter by call status. Multiple values may be comma-separated. example: ended - name: direction in: query required: false schema: type: string enum: - inbound - outbound description: Filter by call direction. example: outbound - name: agent in: query required: false schema: type: string description: Filter by agent display name. example: Front Desk Agent - name: dateFromUTC in: query required: false schema: type: string format: date-time description: Inclusive UTC start date/time. example: '2026-07-01T00:00:00.000Z' - name: dateToUTC in: query required: false schema: type: string format: date-time description: Inclusive UTC end date/time. example: '2026-07-08T23:59:59.999Z' - name: durationMin in: query required: false schema: type: integer minimum: 0 description: Minimum call duration in seconds. example: 30 - name: durationMax in: query required: false schema: type: integer minimum: 0 description: Maximum call duration in seconds. example: 600 - name: phoneNumber in: query required: false schema: type: string description: Search by lead phone number. example: '+14155559876' - name: leadName in: query required: false schema: type: string description: Search by lead name. example: Alex - name: excludeReviewed in: query required: false schema: type: boolean description: When true, exclude calls already reviewed in QA workflows. example: false - name: disposition in: query required: false schema: type: string description: Comma-separated outcome filters. example: appointment,callBack - name: page in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number. example: 1 - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 description: Page size. example: 50 - name: sort in: query required: false schema: type: string enum: - dateTime.desc - dateTime.asc - status.desc - status.asc - duration.desc - duration.asc - projectName.desc - projectName.asc default: dateTime.desc description: Sort as `field.direction`. example: dateTime.desc responses: '200': description: Paginated call records. content: application/json: schema: $ref: '#/components/schemas/CallsListResponse' examples: default: value: success: true data: calls: - id: call_row_123 callId: call_123 date: '2026-07-08' dateTime: '2026-07-08T16:30:00.000Z' leadName: Alex Morgan phoneNumber: '+14155559876' direction: outbound status: ended duration: 184 agent: Front Desk Agent callSummary: Alex asked for pricing and requested a callback. projectName: Acme Clinic recordingUrl: https://app.example.test/recordings/call_123 cost: 2.18 agentType: appointment_booking campaignId: campaign_speed_to_lead_123 campaignName: Speed to Lead disposition: type: callBack label: Callback color: amber pagination: page: 1 limit: 50 total: 128 totalPages: 3 '400': description: Validation failed or the request is malformed. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: VALIDATION message: A required value is missing. '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Unauthorized message: Authentication required. '403': description: Authenticated but not permitted to access the requested resource. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' examples: default: value: success: false error: Forbidden message: You do not have access to this project. '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/CallsErrorResponse' 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/CallsErrorResponse' 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/call-history \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: CallsListResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean data: $ref: '#/components/schemas/CallsListPayload' CallsErrorResponse: 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: A required value is missing. CallsListPayload: type: object additionalProperties: false required: - calls - pagination properties: calls: type: array items: $ref: '#/components/schemas/CallsRecord' pagination: $ref: '#/components/schemas/CallsPagination' summary: type: object additionalProperties: false description: >- Aggregate cost across the whole filtered set. Computed for staff viewers only, so it is absent for `agency_admin` and `project_user`. properties: totalCost: type: number example: 248.72 CallsRecord: type: object additionalProperties: false required: - id - callId - date - dateTime - phoneNumber - direction - status - duration - agent - projectName properties: id: type: string description: Call record id. Use it with Get call. example: call_row_123 callId: type: - string - 'null' description: Platform call id. example: call_123 date: type: string example: '2026-07-08' dateTime: type: string format: date-time example: '2026-07-08T16:30:00.000Z' leadName: type: - string - 'null' example: Alex Morgan phoneNumber: type: string example: '+14155559876' direction: type: string enum: - inbound - outbound - '' example: outbound status: type: string example: ended duration: type: integer minimum: 0 example: 184 agent: type: string example: Front Desk Agent callSummary: type: string example: Alex asked for pricing and requested a callback. projectName: type: string example: Acme Clinic recordingUrl: type: - string - 'null' example: https://app.example.test/recordings/call_123 cost: type: - number - 'null' description: >- Viewer-safe cost for the current account channel, or null when the call is not yet costed. example: 2.18 agentType: type: - string - 'null' description: Agent type that placed the call, as named by the Agents API. example: appointment_booking campaignId: type: - string - 'null' example: campaign_speed_to_lead_123 campaignName: type: - string - 'null' example: Speed to Lead disposition: anyOf: - $ref: '#/components/schemas/CallsOutcome' - type: 'null' CallsPagination: type: object additionalProperties: false required: - page - limit - total - totalPages properties: page: type: integer example: 1 limit: type: integer example: 50 total: type: integer example: 128 totalPages: type: integer example: 3 CallsOutcome: type: object additionalProperties: false required: - type - label - color properties: type: type: string example: callBack label: type: string example: Callback color: type: string example: amber securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````