Skip to main content
GET
List locations

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

page
integer

Offset pagination is bounded at page 10000 (higher values are clamped — meta.current_page reports the page served); use cursor pagination for deeper walks.

Required range: 1 <= x <= 10000
page_size
integer
Required range: 1 <= x <= 100
cursor
string

Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.

id
string

Filter: operator:value

name
string

Filter: operator:value

email
string

Filter: operator:value

phone_number
string

Filter: operator:value

website
string

Filter: operator:value

shift_open
string

Filter: operator:value — the value is true or false

online_booking
string

Filter: operator:value — the value is true or false

feedback_url
string

Filter: operator:value

feedback_rating_trigger
string

Filter: operator:value

feedback_visit_trigger
string

Filter: operator:value

updated_at
string

Filter: operator:value

created_at
string

Filter: operator:value

calendar_view
string

Filter: operator:value

metadata
object

Filter by integrator metadata: metadata[key]=operator:value

Response

Page of locations

data
object[]
meta
object