curl --request GET \
  --url https://api.splose.com/v1/locations \
  --header 'Authorization: Bearer <token>'
{
  "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",
      "onlineBooking": false,
      "timezone": "Australia/Adelaide",
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z",
      "deletedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id_gt
integer | null

The starting object id of the next page

Example:

200

id_lt
integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

"2023-07-30T09:00:00.000Z"

update_lt

Search for objects updated before this date time

Example:

"2023-07-30T09:00:00.000Z"

include_archived
enum<string> | null
default:false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
title
string | null

Location title

Example:

"Rainbow Therapy"

Response

200 - application/json
A paged array of locations
data
object[]
required