> ## 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.

# Contacts API

> Everyone the platform has called or answered, with their latest outcome and next scheduled call. Set do-not-call, and mark your own test leads.

A contact is one person, keyed by phone number, with their calling history.
Concepts and the four ways to stop calling someone are in
[Contacts and leads](/contacts/overview).

| Endpoint                                                                           | Use it to                                                                             |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [List contacts](/api-reference/contacts/list-contacts)                             | Page through contacts with filters for project, campaign, variant, outcome and dates. |
| [List contact filter options](/api-reference/contacts/list-contact-filter-options) | Read the filter values present in your data.                                          |
| [List contact calls](/api-reference/contacts/list-contact-calls)                   | One person's calls and a `dispositionSummary`.                                        |
| [Set contact do-not-call](/api-reference/contacts/set-contact-do-not-call)         | Never call this person in this project.                                               |
| [Clear contact do-not-call](/api-reference/contacts/clear-contact-do-not-call)     | Undo that. A deliberate act.                                                          |
| [Mark contact internal](/api-reference/contacts/mark-contact-internal)             | Keep your own test leads out of the performance figures.                              |
| [Clear contact internal mark](/api-reference/contacts/clear-contact-internal-mark) | Undo that.                                                                            |

Scopes: `contacts:read`, `contacts:write`. See [Authentication](/authentication#scopes).

## Guides

* [Contacts and leads](/contacts/overview)
* [Call records](/calls/overview) for the per-call detail.
* [Test your agent](/agents/test-your-agent) for why you mark test leads.
* [Glossary](/glossary#contacts)
