Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
location

Get a paged array of locations

Get a paged array of locations

get/locations

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

titlestring nullable

Location title

Example:Rainbow Therapy

Response

A paged array of locations

Example response

{
  "data": [
    {
      "id": 1,
      "title": "Rainbow Therapy",
      "abn": "12345678",
      "address": "12345678",
      "postalCode": "5000",
      "suburb": "Adelaide",
      "state": "SA",
      "country": "Australia",
      "phone": "0412345678",
      "email": "rainbow-therapy@splose.com",
      "timezone": "Australia/Adelaide",
      "associatedServiceIds": [
        1,
        2,
        3
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}