Introduction

The Locations endpoint returns information about C42 Locations. The response always includes the general public details of the location and can contain private details related to the authorized user. Within filtering both these public detailand the restricted private details will be queried.

/locations/

Supported methods:

  • GET acceptation

GET /locations/

Returns a default response object with a list of Location objects inside the data object.

As depicted, Location objects may contain one or more labels that add extra details to the location. These labels add extra context for a user or a service. It may for instance mark the location as a work location for the requesting user, or contain service specific details.

Parameters

Parameter Required Description
ids false Array of location ids. To filter on specific locations (reponse is not equally ordered)
sync_token false Sync Token
user_ids false Array of service ids. Only return locations that have labels in relation to user
service_ids false Array of service ids. Only return locations that have labels in relation to the service
search_pattern false String to match on in location text, address, city and label
location_types false Array of Location Type
geo_circles false Array of [Geo Circle]
geo_polylines false Array of GeoPolyline

Note: doesn't support order_by=distance yet

Example

@todo: Add example usage


/locations/<location_id>/

Supported methods:

  • GET acceptation

GET: /locations/<location_id>/

  • Returns a default response object with a list containing the requested Location object inside the data object