Skip to main content
SearchVersion: v3

Search

GET/locations/search

Search Sub-Account (Formerly Location)

Authorizations

Authorizationstringheaderrequired

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

Scope:locations.readonly
Auth methods:OAuthPrivate Integration
Token types:Agency TokenSub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

companyIdstring

The company/agency id on which you want to perform the search

Example:5DP4iH6HLkQsiKESj6rh
skipstring

The value by which the results should be skipped. Default will be 0

Default:0
Example:1
limitstring

The value by which the results should be limited. Default will be 10

Default:10
Example:10
orderstring

The order in which the results should be returned - Allowed values asc, desc. Default will be asc

Default:asc
Example:asc
emailstring
Example:[email protected]

Response

application/json

Successful response

locationsobject[]