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"
      ],
      "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

data

object[]

required

data.id

integer

required

Service id

Required range: x > 0

Example:

1

data.for

enum<string>

required

The service is used for

Available options:

appointment,

support activity

Example:

"appointment"

data.name

string

required

Service name

Example:

"Initial Consultation"

data.description

string | null

required

Service description

Example:

"This is a sample service"

data.type

string | null

required

Service type

Example:

"Other"

data.code

string | null

required

Service code

Example:

"ABC123"

data.duration

number | null

required

Service duration in minute

Example:

90

data.unit

enum<string> | null

required

Service unit

Available options:

Hour,

Each

Example:

"Hour"

data.pricing

number | null

required

Service unit price in dollar

Example:

193.99

data.taxType

required

Tax type, check Splose support for more info

Available options:

STANDARD,

ZERO,

EXEMPT,

REDUCED

Example:

"STANDARD"

data.providerTravelItemCode

string | null

required

Provider travel item code

Example:

""

data.providerTravelPricing

number | null

required

Provider travel item pricing

Example:

0

data.providerTravelNonLabourCostsItemCode

string | null

required

Provider travel non labour cost item code

Example:

""

data.providerTravelNonLabourCostsPricing

number | null

required

Provider travel non labour cost item pricing

Example:

0

data.serviceTags

string[]

required

Service tags

Example:

["NDIS"]

data.createdAt

required

Object creation date time

Example:

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

data.updatedAt

required

Object update date time

Example:

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

data.deletedAt

required

Object archived date time

Example:

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

data.allowProviderTravel

boolean | null

default:false

Whether provider travel is enabled

data.allowProviderTravelNonLabourCosts

boolean | null

default:false

Whether provider travel non labour cost is enabled

links

object

required

Get a single contact Get a single service

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"
      ],
      "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"
  }
}

Get started

API Reference

Authorizations

Query Parameters

Response