ghl_oauth_get_installed_location
Retrieves the locations where a specified app is installed using an agency-level token, with pagination and filters for company, plan, and trial status.
Instructions
REQUIRES AN AGENCY-LEVEL (Company) TOKEN — spec security is Agency-Access-Only, no Location-Access alternative. Legacy twin of GET /oauth/installed-locations (v3); prefer the v3 op for new integrations. [LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Location where app is installed This API allows you fetch location where app is installed upon Endpoint: GET /oauth/installedLocations (Version header: 2021-07-28; source: oauth.json) Requires an Agency (company-level) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: oauth.readonly Pagination params: skip, limit — 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_location"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Parameter to skip the number installed locations | 0 |
| appId | Yes | Parameter to search by the appId | |
| limit | No | Parameter to limit the number installed locations | 20 |
| query | No | Parameter to search for the installed location by name | |
| 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 | |
| companyId | Yes | Parameter to search by the companyId | |
| versionId | No | VersionId of the app | |
| locationId | No | locationId | |
| isInstalled | No | Filters out location which are installed for specified app under the specified company |