Read locations

Retrieves locations accessible to the authenticated API user.

If location_id is supplied, a single location is retrieved.
Otherwise, the endpoint returns a paginated list of locations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Optional client ID to scope the read.

int64
≥ 1

Retrieve a single location by its ID.

integer
≥ 0
Defaults to 50

Maximum number of records returned. Defaults to 50.

integer
≥ 0
Defaults to 0

Number of records to skip. Defaults to 0.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json