Overview

What this reference explains

Connect GoHighLevel lets an end user link one or more GoHighLevel locations to their Sulus account. A location can be added by starting an OAuth install (the API returns an installation URL) or by submitting a location id plus access token manually. When several locations are linked, exactly one can be marked is_default for tools and automations that need a single target.

This reference covers the end-user API under /partner-end-user. The feature flag key for the same switch is ghl_connect.

Connection model

• Rows live in user_ghl_connects, scoped by reseller + user.
• List/create/update/delete/default all return the same projected connection list (never raw tokens).
• GET /status returns a compact view of the most recently updated connection (or connected: false).
• POST /manual-connect is a legacy single-link helper; the Connect UI uses the /connections CRUD instead.

Secrets never leave the API

access_token and refresh_token are accepted on write requests (when provided) and stored server-side. They are never included in JSON responses. Responses expose only safe metadata: location ids, names, default flag, and token_expires_at.

Response envelope

Success responses use {"success": true, "data": ...}. Mutations that refresh the connection list also include a top-level message string. Errors from this controller use {"success": false, "message": "..."}. Feature-disabled responses use the platform feature 403 shape (no success key).

Feature availability

Gated by the ghl_connect feature. When disabled, every endpoint under /partner-end-user returns 403 with {"message":"This feature is not enabled for your account. Please contact your administrator.","feature":"ghl_connect"}.

Out of scope here

• Reseller-admin Connect GoHighLevel under /admin/partner-connect (config, billing sync, reseller-owned connections).
• Browser OAuth callback redirect (public install callback) — not a JSON client endpoint.
• Marketplace SSO login routes used for embedded sign-in.