ProvisioningCreate a GoHighLevel install link

Create a GoHighLevel install link

A link that installs the Mythic GoHighLevel app on one sub-account and links it to this client. Give install_url to someone who can log in to that GoHighLevel account. They must pick a single sub-account; an agency-level install is not linked.

The link does not expire. The return to return_url works for return_expires_in seconds. After that, GET /client/v1/locations/ghl still links the install. On return, return_url receives mythic_ghl=connected&ghl_location_id=…, or mythic_ghl=error&mythic_error=<code>.

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/locations/ghl/install?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "return_url": "https://app.example.com/clients/123"
}'
{
  "success": true,
  "data": {
    "install_url": "example_string",
    "ghl_app_id": "6827fcaec3217895d84d469e",
    "return_expires_in": 86400
  }
}
POST
/client/v1/locations/ghl/install
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) or location secret key (sk_). Writes require an agency key; creating a client requires an agency-wide key. Keys are server-side credentials — this surface serves no CORS headers on purpose. Scoped keys (mcp_) are accepted too: locations:read/locations:write for one client's setup, and provisioning:write to create a client. See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_). Writes require an agency key; creating a client requires an agency-wide key. Keys are server-side credentials — this surface serves no CORS headers on purpose. Scoped keys (mcp_) are accepted too: locations:read/locations:write for one client's setup, and provisioning:write to create a client. See Using an mcp_ key over HTTP.
query
location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_. Not used when creating a client.

Content-Typestring
Required

The media type of the request body

Options: application/json
return_urlstring

Where to send the browser afterwards. Its origin must be in the agency's oauth_return_origins.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) or location secret key (sk_). Writes require an agency key; creating a client requires an agency-wide key. Keys are server-side credentials — this surface serves no CORS headers on purpose. Scoped keys (mcp_) are accepted too: locations:read/locations:write for one client's setup, and provisioning:write to create a client. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_. Not used when creating a client.

Body

application/json
return_urlstring

Where to send the browser afterwards. Its origin must be in the agency's oauth_return_origins.

Example:
https://app.example.com/clients/123

Responses

successboolean
dataobject