> ## 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. # List appointments for a contact > Everything booked for one contact, across every calendar in the sub-account. Cancelled ones are left out unless you ask for them, because the common question is "what do they have coming up". Required API key scope: `projects:read`. ## OpenAPI ````yaml /openapi.yaml get /api/native-calendar/appointments 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: Manage voice agents, campaigns, workflows, and outcomes. - name: Analytics description: >- Minimal, non-billing performance summary: volume, conversion, and pickup metrics. - name: Billing description: >- Billing for your own agency: balance, spend, transaction history, invoices and sub-account wallets; auto-recharge, rebilling, Credit Guard and Stripe customers; and, with the billing:charge scope, purchases and charges. - 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: 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: >- 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: Split Testing description: >- Split live campaign traffic across agent variants and shift the weights between them. - name: Voices description: Voice catalogue endpoints for choosing the voice used by an agent. paths: /api/native-calendar/appointments: get: tags: - Native Calendar summary: List appointments for a contact description: >- Everything booked for one contact, across every calendar in the sub-account. Cancelled ones are left out unless you ask for them, because the common question is "what do they have coming up". Required API key scope: `projects:read`. operationId: list-native-contact-appointments parameters: - name: locationId in: query required: true schema: type: string description: >- The sub-account this calendar belongs to. It is the only thing that identifies the tenant here, and access is re-checked against it on every call. example: nat_fd9e2a8dd4be4396b604 - name: contactId in: query required: true schema: type: string description: The contact whose appointments these are. example: nct_0123456789abcdef0123 - name: includeCancelled in: query required: false schema: type: string enum: - 'true' description: Include cancelled appointments. example: 'true' responses: '200': description: The contact's appointments. content: application/json: schema: $ref: '#/components/schemas/NativeAppointmentListResponse' examples: default: value: success: true data: - _id: apt_7d21c0f4a1 locationId: nat_fd9e2a8dd4be4396b604 calendarId: cal_6b1f2a7c90 calendarName: Consultations contactId: nct_0123456789abcdef0123 contactName: Ana Diaz title: Implant consultation status: confirmed startTime: '2026-09-24T15:00:00.000Z' endTime: '2026-09-24T15:30:00.000Z' source: call createdAt: '2026-09-20T09:14:52.000Z' '400': description: >- The request is malformed, or the calendar definition is invalid. `errors` carries every reason, not only the first. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: timezone is required '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: Unauthorized '403': description: >- Authenticated, but without access to this sub-account or this calendar. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: calendar does not belong to this project '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: TooManyRequests '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: Calendar request failed. '503': description: The calendar service is unreachable or not configured. content: application/json: schema: $ref: '#/components/schemas/NativeCalendarErrorResponse' examples: default: value: success: false error: Calendar service is unreachable. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/native-calendar/appointments \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: NativeAppointmentListResponse: type: object additionalProperties: {} required: - success - data properties: success: type: boolean data: type: array items: $ref: '#/components/schemas/NativeAppointment' NativeCalendarErrorResponse: type: object additionalProperties: {} required: - success - error properties: success: type: boolean error: type: string example: timezone is required errors: type: array items: type: string description: Every reason a calendar definition was refused, not only the first. upcomingCount: type: integer description: >- On a refused delete: how many appointments are still ahead on this calendar. example: 3 NativeAppointment: type: object additionalProperties: {} required: - _id - calendarId - startTime - status properties: _id: type: string example: apt_7d21c0f4a1 locationId: type: string example: nat_fd9e2a8dd4be4396b604 calendarId: type: string example: cal_6b1f2a7c90 calendarName: type: string example: Consultations contactId: type: - string - 'null' description: >- Null on an entry that is not a lead: a meeting, a reminder, time held. example: nct_0123456789abcdef0123 contactName: type: string example: Ana Diaz title: type: string example: Implant consultation status: type: string enum: - confirmed - showed - cancelled - noshow description: >- `confirmed` and `showed` hold a seat; `cancelled` and `noshow` free it. A past appointment that happened still holds its seat, so a second booking cannot land on a slot that was genuinely used. example: confirmed startTime: type: string example: '2026-09-24T15:00:00.000Z' endTime: type: string example: '2026-09-24T15:30:00.000Z' source: type: string description: 'Where it came from: `call`, `api`, `dashboard`.' example: call createdAt: type: string example: '2026-09-20T09:14:52.000Z' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````