ProvisioningGet the GoHighLevel connection

Get the GoHighLevel connection

This client's GoHighLevel connection. status is active, not_connected, token_inactive (the app was uninstalled or its token lapsed), or incomplete.

Reading this also links an install that finished without the browser returning to Mythic, so a headless caller can poll it after handing out the install link. It never clears a ghl_location_id that was set by hand.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/locations/ghl?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "connected": true,
    "status": "active",
    "ghl_location_id": "HjiMUOsCCHCjtxzEf8PR",
    "connected_at": "2024-12-25T10:00:00Z",
    "proxy_api_key_set": true
  }
}
GET
/client/v1/locations/ghl
GET
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.

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.

Responses

successboolean
dataobject