v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Location

List Locations

Retrieve a list of locations

get/location

Query parameters

idstring

Location ID

created_atstring

Creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

namestring

Name of the location

external_idstring

External ID

streetstring

Street address

postal_codestring

Postal or ZIP code

citystring

City

regionstring

Region or state

iso_countrystring

ISO 3166-1 alpha-2 country code

address_linestring

Full formatted address line (generated)

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: created_at, updated_at, name

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Location ID

created_atstring timestamp with time zone

Creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

namestring text

Name of the location

external_idstring text nullable

External ID

streetstring text nullable

Street address

postal_codestring text nullable

Postal or ZIP code

citystring text nullable

City

regionstring text nullable

Region or state

iso_countrystring text nullable

ISO 3166-1 alpha-2 country code

address_linestring text nullable

Full formatted address line (generated)