Skip to main content
Your agent books into a GoHighLevel calendar, applies GoHighLevel tags, and writes GoHighLevel custom fields. Every one of those has an id inside the sub-account, and the settings that use them want the id, not the label. These endpoints read the sub-account so you never have to guess. Nothing here writes to GoHighLevel. Writes happen through the agent’s skills and the campaign’s workflow.

​
What you can read

Custom fields and custom values come in two flavours of endpoint: by agent, under /api/agent-builder/agents/{id}/ghl-custom-fields, which resolves the agent’s own project, and by location, under /api/agent-builder/locations/{locationId}/ghl-custom-fields, for when you have the locationId and no agent yet. Calendars and tags are read by location only.

​
Using them in the prompt

A custom field’s fieldKey can be dropped into the agent’s prompt. The value for the lead being called is filled in at dial time, so the agent can open with “you asked about a kitchen remodel” rather than “you asked about our services”. See The prompt.

​
When the connection is not healthy

Every read here depends on the project’s GoHighLevel connection. Three error codes tell you what kind of broken it is: See Agencies, projects and sub-accounts for project states.

​
Boundaries

  • These endpoints read the live sub-account. A tag created in GoHighLevel a second ago is already here.
  • Ids are per sub-account. A calendar id from one client’s sub-account means nothing in another’s. This is why a master agent binds assets by name.
  • The lookup finds a contact by phone number only.

​
In the API