Skip to main content
GET
Retrieves locations

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Query Parameters

contract_id
integer<int32>

ID of the Contract

latitude
number<float>

Latitude coordinate for filtering nearby results within a 5 km radius. Must be used together with longitude.

longitude
number<float>

Longitude coordinate for filtering nearby results within a 5 km radius. Must be used together with latitude.

Free-text search across location properties including name, identifier, street, house number and city.

Required string length: 4 - 256
limit
integer<int64>

Maximum number of items per page. Maximum value is 25.

Required range: 1 <= x <= 25
Example:

"10"

page
integer<int64>

Page number to retrieve (starting from 1).

Required range: x >= 1
Example:

"1"

Response

Location collection

locations
object[]
required

Locations

pagination
object

Pagination