Skip to content

Locations

Endpoints for retrieving the list of locations.

GET /api/v1/Location/Simple

Returns a list of all active locations.

Parameters

This endpoint has no parameters.

Response

FieldTypeDescription
IdLocationuuidLocation identifier
NamestringLocation name

GET /api/v1/Location/Extended

Returns a list of locations with extended information.

Parameters

ParameterTypeRequiredDescription
activeboolnoFilter by location activity (true = active, false = inactive)

Response

FieldTypeDescription
IdLocationuuidLocation identifier
NamestringPublic location name
NameInternalstringInternal name
RegNumberstringCompany registration number
VatNumberstringVAT number
PhonestringLocation phone number
EmailstringLocation email address
CitystringCity
StreetstringStreet
PoststringPostal code
ActiveboolWhether the location is active