GoHighLevel API reference
OAuth scopes
GoHighLevel publishes 124 OAuth scopes across 74 resources. Scopes follow a resource.readonly / resource.write shape, and the two are independent — granting write does not imply read. Request the narrowest set your integration actually needs; every extra scope is something a customer has to consent to at install time.
The same names apply to Private Integration Tokens, which are issued inside a single sub-account with a chosen subset of these scopes.
Which scope unlocks which endpoint
HighLevel documents the scope list and the endpoint list separately, leaving the join to you. This is that join for the 53 endpoints documented on this site.
Every scope by resource
All 124 scopes, grouped by the resource they authorize.
agent-studio
| Resource | Scopes |
|---|---|
agent-studio | agent-studio.readonlyagent-studio.write |
associations
| Resource | Scopes |
|---|---|
associations | associations.readonlyassociations.write |
associations/relation | associations/relation.readonlyassociations/relation.write |
blogs
| Resource | Scopes |
|---|---|
blogs/author | blogs/author.readonly |
blogs/category | blogs/category.readonly |
blogs/check-slug | blogs/check-slug.readonly |
blogs/list | blogs/list.readonly |
blogs/post | blogs/post.write |
blogs/post-update | blogs/post-update.write |
blogs/posts | blogs/posts.readonly |
brand-boards
| Resource | Scopes |
|---|---|
brand-boards/design-kit | brand-boards/design-kit.readonlybrand-boards/design-kit.write |
brand-boards/voices | brand-boards/voices.readonlybrand-boards/voices.write |
businesses
| Resource | Scopes |
|---|---|
businesses | businesses.readonlybusinesses.write |
calendars
| Resource | Scopes |
|---|---|
calendars | calendars.readonlycalendars.write |
calendars/events | calendars/events.readonlycalendars/events.write |
calendars/groups | calendars/groups.readonlycalendars/groups.write |
calendars/resources | calendars/resources.readonlycalendars/resources.write |
campaigns
| Resource | Scopes |
|---|---|
campaigns | campaigns.readonly |
charges
| Resource | Scopes |
|---|---|
charges | charges.readonlycharges.write |
companies
| Resource | Scopes |
|---|---|
companies | companies.readonly |
contacts
| Resource | Scopes |
|---|---|
contacts | contacts.readonlycontacts.write |
conversation-ai
| Resource | Scopes |
|---|---|
conversation-ai | conversation-ai.readonlyconversation-ai.write |
conversations
| Resource | Scopes |
|---|---|
conversations | conversations.readonlyconversations.write |
conversations/livechat | conversations/livechat.write |
conversations/message | conversations/message.readonlyconversations/message.write |
custom-menu-link
| Resource | Scopes |
|---|---|
custom-menu-link | custom-menu-link.readonlycustom-menu-link.write |
emails
| Resource | Scopes |
|---|---|
emails/builder | emails/builder.readonlyemails/builder.write |
emails/schedule | emails/schedule.readonlyemails/schedule.write |
forms
| Resource | Scopes |
|---|---|
forms | forms.readonlyforms.write |
funnels
| Resource | Scopes |
|---|---|
funnels/redirect | funnels/redirect.readonlyfunnels/redirect.write |
invoices
| Resource | Scopes |
|---|---|
invoices | invoices.readonlyinvoices.write |
invoices/estimate | invoices/estimate.readonlyinvoices/estimate.write |
invoices/schedule | invoices/schedule.readonlyinvoices/schedule.write |
invoices/template | invoices/template.readonlyinvoices/template.write |
links
| Resource | Scopes |
|---|---|
links | links.readonlylinks.write |
locations
| Resource | Scopes |
|---|---|
locations | locations.internal-access-onlylocations.readonlylocations.write |
locations/customFields | locations/customFields.readonlylocations/customFields.write |
locations/customValues | locations/customValues.readonlylocations/customValues.write |
locations/read | locations/read |
locations/tags | locations/tags.readonlylocations/tags.write |
locations/tasks | locations/tasks.readonly |
locations/templates | locations/templates.readonly |
locations/write | locations/write |
marketplace-external-auth-migration
| Resource | Scopes |
|---|---|
marketplace-external-auth-migration | marketplace-external-auth-migration.write |
marketplace-installer-details
| Resource | Scopes |
|---|---|
marketplace-installer-details | marketplace-installer-details.readonly |
medias
| Resource | Scopes |
|---|---|
medias | medias.readonlymedias.write |
numberpools
| Resource | Scopes |
|---|---|
numberpools | numberpools.read |
oauth
| Resource | Scopes |
|---|---|
oauth | oauth.readonlyoauth.write |
objects
| Resource | Scopes |
|---|---|
objects/record | objects/record.readonlyobjects/record.write |
objects/schema | objects/schema.readonlyobjects/schema.write |
opportunities
| Resource | Scopes |
|---|---|
opportunities | opportunities.readonlyopportunities.write |
payments
| Resource | Scopes |
|---|---|
payments/coupons | payments/coupons.readonlypayments/coupons.write |
payments/custom-provider | payments/custom-provider.readonlypayments/custom-provider.write |
payments/integration | payments/integration.readonlypayments/integration.write |
payments/orders | payments/orders.collectPaymentpayments/orders.readonlypayments/orders.write |
payments/subscriptions | payments/subscriptions.readonly |
payments/transactions | payments/transactions.readonly |
phonenumbers
| Resource | Scopes |
|---|---|
phonenumbers | phonenumbers.readphonenumbers.write |
products
| Resource | Scopes |
|---|---|
products | products.readonlyproducts.write |
products/collection | products/collection.readonlyproducts/collection.write |
products/prices | products/prices.readonlyproducts/prices.write |
saas
| Resource | Scopes |
|---|---|
saas/company | saas/company.readsaas/company.write |
socialplanner
| Resource | Scopes |
|---|---|
socialplanner/account | socialplanner/account.readonly |
socialplanner/category | socialplanner/category.readonlysocialplanner/category.write |
socialplanner/csv | socialplanner/csv.write |
socialplanner/oauth | socialplanner/oauth.readonly |
socialplanner/post | socialplanner/post.readonlysocialplanner/post.write |
socialplanner/statistics | socialplanner/statistics.readonly |
surveys
| Resource | Scopes |
|---|---|
surveys | surveys.readonly |
users
| Resource | Scopes |
|---|---|
users | users.readonlyusers.write |
voice-ai-agent-goals
| Resource | Scopes |
|---|---|
voice-ai-agent-goals | voice-ai-agent-goals.readonlyvoice-ai-agent-goals.write |
voice-ai-agents
| Resource | Scopes |
|---|---|
voice-ai-agents | voice-ai-agents.readonlyvoice-ai-agents.write |
voice-ai-dashboard
| Resource | Scopes |
|---|---|
voice-ai-dashboard | voice-ai-dashboard.readonly |
workflows
| Resource | Scopes |
|---|---|
workflows | workflows.readonly |
Common questions
- How many OAuth scopes does GoHighLevel have?
- HighLevel publishes 124 OAuth scopes across 74 resources. Most resources expose a matching pair — a .readonly scope for GET requests and a .write scope for anything that changes state.
- What is the difference between a readonly and a write scope?
- A .readonly scope authorizes GET requests against that resource; a .write scope authorizes creates, updates, and deletes. They are independent — granting write does not imply read, so an app that both lists and edits contacts needs contacts.readonly and contacts.write.
- Do Private Integration Tokens use the same scopes as OAuth apps?
- Yes. A Private Integration Token is issued inside a sub-account with a chosen set of the same scope names, which is why an endpoint's scope requirement is the same either way. The difference is distribution: a PIT belongs to one location, while an OAuth app is installed across many.
- Which scope does a specific endpoint need?
- Each endpoint reference page lists its required scopes alongside its parameters and response. The cross-reference on this page runs the other direction — pick a scope and see the documented endpoints it unlocks.
Skip the schema lookup
Getting scopes wrong costs a reinstall — a missing one surfaces as a 401 long after consent. Hylo tells your AI agent which scope each call needs before it makes the call.
Elsewhere in the reference