HighLevel: Oauth schemas

← Oauth operations · All schemas

Get Location where app is installed — response body

Field	Type	Presence	Description and constraints
$	object	Root
installToFutureLocations	boolean	Optional	Boolean to control if user wants app to be automatically installed to future locations
items	array	Required within parent	List of locations with their installation status for the requested app
items[]	Model	Each item	Expand Get Location where app is installed — response body — items item
metadata	JSON	Optional	Query metadata (filters and sort applied)
metadata (allOf 1)	Model	All variants apply	Expand Get Location where app is installed — response body — metadata filter Applied, sort Applied
pagination	JSON	Required within parent	Pagination metadata (AIP-158)
pagination (allOf 1)	Model	All variants apply	Expand Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Referenced models: Get Location where app is installed — response body — items item, Get Location where app is installed — response body — metadata filter Applied, sort Applied, Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Get Location where app is installed — response body — items item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Location ID
address	string	Required within parent	Address linked to location
installedAt	string	Optional	Timestamp when the app was installed on this location Format: date-time
isInstalled	boolean	Optional	Check if the requested app is installed for following location
name	string	Required within parent	Name of the location
versionId	string	Optional	Version ID of the installed app version for this location

Get Location where app is installed — response body — metadata filter Applied, sort Applied

Field	Type	Presence	Description and constraints
$	object	Root
filterApplied	object	Optional	Filters that were applied to the query Additional keys: allowed
sortApplied	object	Optional	Sort order that was applied to the query Additional keys: allowed

Get Location where app is installed — response body — pagination current Page Size, estimated Total Records, has Next Page, has Prev Page, next Page Token, prev Page Token, total Records

Field	Type	Presence	Description and constraints
$	object	Root
currentPageSize	JSON	Required within parent
currentPageSize (anyOf 1)	number	Alternative	Number of items returned in the current page
currentPageSize (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimatedTotalRecords	JSON	Optional
estimatedTotalRecords (anyOf 1)	number	Alternative	Estimated total records; present when exact total is unknown
estimatedTotalRecords (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hasNextPage	boolean	Required within parent	True when a next page is available
hasPrevPage	boolean	Required within parent	True when a previous page is available
nextPageToken	string	Optional	Opaque token to fetch the next page
prevPageToken	string	Optional	Opaque token to fetch the previous page
totalRecords	JSON	Optional
totalRecords (anyOf 1)	number	Alternative	Total number of records matching the query across all pages
totalRecords (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$