Skip to main content
List Locations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

id
string

Location ID

created_at
string

Creation date

updated_at
string

Latest update

organisation_id
string

Organisation ID

name
string

Name of the location

external_id
string

External ID

street
string

Street address

postal_code
string

Postal or ZIP code

city
string

City

region
string

Region or state

iso_country
string

ISO 3166-1 alpha-2 country code

address_line
string

Full formatted address line (generated)

select
string

Filtering Columns

order
string

Ordering. Allowed Fields: created_at, updated_at, name

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

200 - application/json

OK

id
string<uuid>
default:random uuid

Location ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of the location

external_id
string<text> | null

External ID

street
string<text> | null

Street address

postal_code
string<text> | null

Postal or ZIP code

city
string<text> | null

City

region
string<text> | null

Region or state

iso_country
string<text> | null

ISO 3166-1 alpha-2 country code

address_line
string<text> | null

Full formatted address line (generated)