Get a paged array of services
curl --request GET \
  --url https://api.splose.com/v1/services \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "for": "appointment",
      "name": "Initial Consultation",
      "description": "This is a sample service",
      "type": "Other",
      "code": "ABC123",
      "duration": 90,
      "unit": "Hour",
      "pricing": 193.99,
      "taxType": "STANDARD",
      "allowProviderTravel": false,
      "providerTravelItemCode": "",
      "providerTravelPricing": 0,
      "allowProviderTravelNonLabourCosts": false,
      "providerTravelNonLabourCostsItemCode": "",
      "providerTravelNonLabourCostsPricing": 0,
      "serviceTags": [
        "NDIS"
      ],
      "archived": false,
      "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
​
name
string | null

Service name

Example:

"Initial Consultation"

​
type
string | null

Service type

Example:

"Other"

​
code
string | null

Service code

Example:

"ABC123"

​
serviceTag
string | null

Service tag

Example:

"NDIS"

Response

200 - application/json

A paged array of services

The response is of type object.