Skip to main content
Version: 2023-02-21

Get Location where app is installed

GET 
/oauth/installedLocations

Fetch the locations where the app is installed.

Request​

Version stringrequired

API Version

Available options2023-02-21
skip string

Parameter to skip the number installed locations

Default value:0
limit string

Parameter to limit the number installed locations (max 100)

Default value:10
query string

Parameter to search for the installed location by name

isInstalled boolean

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

restrictToUserLocations boolean

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.

companyId stringrequired

Parameter to search by the companyId

appId stringrequired

Parameter to search by the appId

versionId string

VersionId of the app

sortOrder string

Sort order for installedAt date. Defaults to desc (latest first)

Available optionsascdesc
installedAfter string

Filter locations installed on or after this date (ISO 8601)

installedBefore string

Filter locations installed on or before this date (ISO 8601)

onTrial boolean

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

planId string

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

locationId string

locationId

application/json

Successful response

Schema
    locationsobject[]

    List of locations with their installation status for the requested app

    countnumber

    Total location count under the company

    installToFutureLocationsboolean

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