API Reference

location.list

post
https://api.ashbyhq.com/location.list

List all locations. Regions are not returned.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the organizationRead permission.

Body Params
string

Opaque cursor indicating which page of results to fetch

string

An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.

number

The maximum number of items to return. The maximum and default value is 100.

boolean
Defaults to false

When true, includes archived items

boolean
Defaults to false

If true, the response will include the location hierarchy (regions).

Response

Updated 5 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago