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

# GHL API

> Read the tags, calendars, custom fields and custom values in a GoHighLevel sub-account, and look up a contact by phone, so skills and workflows can be wired by id.

These endpoints read the connected sub-account. They never write to it; the
agent's skills and the campaign's workflow do that. Concepts are in
[GoHighLevel resources](/ghl/overview).

| Endpoint                                                                              | Use it to                                                        |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| [List GHL tags](/api-reference/ghl/list-ghl-tags)                                     | Tags in the sub-account, for entry and exit tags and tag skills. |
| [List GHL calendars](/api-reference/ghl/list-ghl-calendars)                           | Calendars, for booking.                                          |
| [List agent GHL custom fields](/api-reference/ghl/list-agent-ghl-custom-fields)       | Custom fields, resolved through the agent's project.             |
| [List location GHL custom fields](/api-reference/ghl/list-location-ghl-custom-fields) | The same, by `locationId`.                                       |
| [List agent GHL custom values](/api-reference/ghl/list-agent-ghl-custom-values)       | Custom values, resolved through the agent's project.             |
| [List location GHL custom values](/api-reference/ghl/list-location-ghl-custom-values) | The same, by `locationId`.                                       |
| [Lookup GHL contact](/api-reference/ghl/lookup-ghl-contact)                           | Find a contact by phone number. `contact: null` when none.       |

Scopes: `ghl:read`. See [Authentication](/authentication#scopes).

## Guides

* [GoHighLevel resources](/ghl/overview), including the connection error codes.
* [The prompt](/agents/prompt) for using `fieldKey` values in the prompt.
* [Glossary](/glossary#gohighlevel)