About Our Developer Documentation

HighLevel is currently in the process of moving to an OAuth 2.0-based API (API 2.0), and at some point in the future, this will be the only API available for integration once this migration is complete. Until this time, we have two APIs, which we are calling the API 1.0 and the API 2.0 for added clarity when referencing which API you are utilizing. See further details below.


API 1.0 Docs
https://public-api.gohighlevel.com/

  • No new endpoints are planned for the Public API at this time.
  • "Public API (v1)" has been renamed to API 1.0 for clarity.


API 2.0 Docs

https://highlevel.stoplight.io/docs/integrations/0443d7d1a4bd0-overview

  • Going forward, be sure to use the API 2.0 Docs for new integrations as all future endpoints and new API functionality will be added here.
  • As of now, not all endpoints from the API 1.0 Docs have been integrated into the API 2.0 Docs.
  • Pro Tip: To ensure an uninterrupted API integration, be sure to regularly review and update your integration as soon as a new endpoint becomes available in the API 2.0 Docs.
  • "OAuth 2.0 API (v2)" has been renamed to API 2.0 for clarity.


Check out our Developers Landing Page, where you can find the Developer Marketplace, Documentation, Slack Channel, and more! -->  https://developers.gohighlevel.com/



How to Get Help or Support for the HighLevel API

How to Submit a New API-Related Idea to HighLevel

Differences Between API Access Across Plan Levels

What is an API Key and how is it used?


Where To Find The Agency & Location API Keys

1. Location Level > Settings > Business Info

2. Agency Level > Agency Settings > API Keys to view all Location API keys in one place


Troubleshooting





How to Get Help or Support for the HighLevel API


At this time, HighLevel Support does NOT provide setup code auditing or developer consultative services on API-Related topics. However, if your setup is complete and correct - yet an error persists, you may have encountered an API Bug we need to fix. 

You can report this bug by filling out this form: https://speakwith.us/dev-ticket







Our API Docs list all available endpoints that are publicly available. If you don’t see an endpoint on either of the API developer sites listed below, we recommend visiting our Roadmap & Ideas Board to add your idea! 

You can also track the progress of new ideas as they make their way through planning and into production on our roadmap. This board is both for new developer features and consumer features alike.




Differences Between API Access Across Plan Levels


Basic API access is included with our Starter and Unlimited plans, while Advanced API access is available on our Agency Pro plan. 


In addition to the future endpoints that will be released in our OAuth 2.0 API (which is only available in our Advanced API access), this tier unlocks the use of Agency API Keys where lower plan levels only access Location API Keys. 






What is an API Key and how is it used?

An application programming interface key (API key) is a unique identifier used to authenticate a user, developer, or data passed via API. It's essentially a secret Key that you want to keep close and not share.

An authorized API key will allow you to pass data between software automatically using applications like Zapier, Pabbly, Integrately, Make (Formerly Integromat), API Nation, and others.




Where To Find The Agency & Location API Keys

Where to find the Location Level API Key?


1. Location Level > Settings > Business Info



2. Agency Level > Agency Settings > API Keys to view all Location API keys in one place






Troubleshooting

How to Update your API Keys

How do I know if my API Key is old?

What will happen if my API key is compromised?

What do I do if my API key is blank?