ghl_oauth_get_installed_locations
Fetch all locations where a GoHighLevel app is installed using an agency-level OAuth token, with pagination and filters for company, plan, trial status, and installation state.
Instructions
REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, no Location-Access alternative. Get Location where app is installed This API allows you fetch location where app is installed upon Endpoint: GET /oauth/installed-locations (Version header: v3; source: v3/oauth-v3.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly Pagination params: pageSize — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"companyId": "<companyId>",
"appId": "<appId>"
},
"name": "ghl_oauth_get_installed_locations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes | Parameter to search by the appId | |
| query | No | Literal installed-location name search. Leading and trailing whitespace is ignored. | |
| planId | No | Filters out location which are installed for specified app under the specified planId | |
| onTrial | No | Filters out locations which are installed for specified app in trial mode | |
| pageSize | No | Max items per page (1-100). Replaces legacy `limit` parameter per AIP-158. | |
| companyId | Yes | Parameter to search by the companyId | |
| pageToken | No | Opaque token returned in a previous response to fetch the next page. Replaces legacy `skip` parameter per AIP-158. | |
| versionId | No | VersionId of the app | |
| locationId | No | locationId | |
| isInstalled | No | Filters out location which are installed for specified app under the specified company | |
| restrictToUserLocations | No | When true, restricts the list to locations the current user has access to (for restricted agency admins and account admins). When false or omitted, no user-based filter is applied for installed list; for backward compatibility, install list (isInstalled=false) is still filtered by user when this param is omitted. |