locations list
GET {{baseUrl}}/locations
Returns a list of Location objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"f5e6a151-f44e-449a-afb1-8fd781905958","remote_id":"93018402","name":"NYC Office","phone_number":"+1111111111","street_1":"2920 Broadway","street_2":"2nd Floor","city":"New York ","state":"NY","zip_code":"10027","country":"NE","location_type":"WORK","remote_data":[{"path":"cillum labore ex","data":{"Excepteur_4":{},"occaecat60a":{}}},{"path":"consectetur","data":{"enim_":{}}}],"remote_was_deleted":false},{"id":"f5e6a151-f44e-449a-afb1-8fd781905958","remote_id":"93018402","name":"NYC Office","phone_number":"+1111111111","street_1":"2920 Broadway","street_2":"2nd Floor","city":"New York ","state":"NY","zip_code":"10027","country":"MU","location_type":"HOME","remote_data":[{"path":"magna dolore","data":{"Duis1":{},"occaecatd":{},"quis54":{}}},{"path":"mollit ipsum","data":{"veniam6fe":{}}}],"remote_was_deleted":false}]}