GuidesAPI ReferenceSDKsChangelogSupportPartner Program
API Reference
Go to dashboard

Get locations

get
https://api.envoy.com/rest/v1/locations

Retrieve a list of locations for a specific company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of strings

A list of location ids

ids
string

Show locations created at or after this date. Date must be provided in UTC.

string

Show locations created at or before this date. Date must be provided in UTC.

string
enum

Controls which field should be compared to sort the results. Possible values are "createdAt" or "updatedAt". Use with order.

Allowed:
string
enum

Controls the sorting direction. Possible values are "ASC" and "DESC", use with sort.

Allowed:
boolean

Show active or inactive locations. Accepts boolean values true or false.

integer
≥ 1
Defaults to 1

The page number for pagination.

integer
1 to 100
Defaults to 100

Number of items per page.

Response

Updated 11 months ago

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

Updated 11 months ago