Skip to main content
OAuth 2.0Version: v3New

Get Location where app is installed

GET/oauth/installed-locations

This API allows you fetch location where app is installed upon

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:oauth.readonly
Auth method:OAuth
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

pageSizenumber

Max items per page (1-100). Replaces legacy limit parameter per AIP-158.

Default:20
Example:20
pageTokenstring

Opaque token returned in a previous response to fetch the next page. Replaces legacy skip parameter per AIP-158.

Example:eyJza2lwIjoyMH0
querystring

Literal installed-location name search. Leading and trailing whitespace is ignored.

Possible values: <= 100 characters

Example:location name
isInstalledboolean

Filters out location which are installed for specified app under the specified company

Example:true
restrictToUserLocationsboolean

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.

Example:true
companyIdstringrequired

Parameter to search by the companyId

Example:tDtDnQdgm2LXpyiqYvZ6
appIdstringrequired

Parameter to search by the appId

Example:tDtDnQdgm2LXpyiqYvZ6
versionIdstring

VersionId of the app

Example:tDtDnQdgm2LXpyiqYvZ6
onTrialboolean

Filters out locations which are installed for specified app in trial mode

Example:true
planIdstring

Filters out location which are installed for specified app under the specified planId

Example:true
locationIdstring

locationId

Example:1245

Response

application/json

Successful response

itemsobject[]required

List of locations with their installation status for the requested app

paginationobjectrequired

Pagination metadata (AIP-158)

metadataobject

Query metadata (filters and sort applied)

installToFutureLocationsboolean

Boolean to control if user wants app to be automatically installed to future locations

Example:true