ESescape
Locations

List locations

List and search locations of the organization.

get/locations

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'LAST_SEEN' | 'NAME' | 'TYPE'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

searchstring
Example:location1
enabled'true' | 'false'
Example:true
typestring[]

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.