ghl_oauth_get_installed_location
Retrieve locations where an app is installed using agency-level token. Supports pagination and filters like location name, trial status, and plan ID.
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. 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) OAuth scopes: oauth.readonly Pagination params: skip, limit — pass them to page through full result sets.
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 |