GoHighLevel Python API Docs | dltHub

Build a GoHighLevel-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

GoHighLevel is a CRM and marketing automation platform exposing a REST API to manage contacts, locations, accounts, opportunities, appointments, funnels, campaigns, and related resources. The REST API base URL is https://services.leadconnectorhq.com and All requests require a Bearer token (OAuth2 access token or Private Integration token) in the Authorization header..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading GoHighLevel data in under 10 minutes.


What data can I load from GoHighLevel?

Here are some of the endpoints you can load from GoHighLevel:

ResourceEndpointMethodData selectorDescription
contacts/contacts/ (deprecated) and /contacts/searchGETresults (search) / contact (single)Search and retrieve contacts (use Search Contacts endpoint for lists).
contact/contacts/{contactId}GET(object)Retrieve a single contact by ID.
locations/locations/GETlocationsList account locations.
accounts/accounts/GETaccountsList accounts.
opportunities/opportunities/GETopportunitiesList sales opportunities.
pipelines/pipelines/GETpipelinesRetrieve pipelines.
appointments/appointments/GETappointmentsList appointments/bookings.
knowledge_base/knowledge-base/GET(object/array)KB endpoints; requires sub-account or private integration token.

How do I authenticate with the GoHighLevel API?

Use an OAuth2 access token (Authorization: Bearer ) or a Private Integration token placed in the same header. Requests should include Accept: application/json and Content-Type: application/json where appropriate.

1. Get your credentials

  1. In HighLevel dashboard go to Marketplace > Private Integrations (or create a Marketplace App). 2) For Private Integration: create token scoped to sub-account or location and copy the token. 3) For OAuth: create app, note client_id and client_secret, perform OAuth flow to exchange code for access token at /oauth/token. 4) Use the token in Authorization header.

2. Add them to .dlt/secrets.toml

[sources.gohighlevel_source] api_key = "your_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the GoHighLevel API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python gohighlevel_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline gohighlevel_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset gohighlevel_data The duckdb destination used duckdb:/gohighlevel.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline gohighlevel_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads contacts and locations from the GoHighLevel API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def gohighlevel_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://services.leadconnectorhq.com", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "contacts", "endpoint": {"path": "contacts/search", "data_selector": "results"}}, {"name": "locations", "endpoint": {"path": "locations/", "data_selector": "locations"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="gohighlevel_pipeline", destination="duckdb", dataset_name="gohighlevel_data", ) load_info = pipeline.run(gohighlevel_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("gohighlevel_pipeline").dataset() sessions_df = data.contacts.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM gohighlevel_data.contacts LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("gohighlevel_pipeline").dataset() data.contacts.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load GoHighLevel data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Troubleshooting

Authentication failures

If you receive 401 Unauthorized: verify Authorization: Bearer , ensure token is not expired, and that you used a Sub-Account or Private Integration token for sub-account-scoped resources.

Rate limits

HighLevel enforces rate limiting; if you receive 429 Too Many Requests, implement exponential backoff and respect Retry-After header.

Pagination quirks

Search endpoints return paginated results; inspect the response for page, total, per_page or links. Use the Search Contacts endpoint instead of the deprecated /contacts/ list.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for GoHighLevel?

Request dlt skills, commands, AGENT.md files, and AI-native context.