Skip to content

Get Locations
Alpha

Request

Get all locations for the company.

Security
OAuth2(Required scopes: location.read)
Query
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page. Defaults to 100, maximum 100.

Default:100
curl -i -X GET \
  'https://api.understory.io/v1/locations?cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

itemsArray of objects(Location)

The list of locations on the current page.

Response
{
  "next": "string",
  "items": [
    { … }
  ]
}