Skip to main content
Get a single service
curl --request GET \
  --url https://api.splose.com/v1/services/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with service data.

​
id
integer
required

Service id

Required range: x > 0
Example:

1

​
for
enum<string>
required

The service is used for

Available options:
appointment,
support activity
Example:

"appointment"

​
name
string
required

Service name

Example:

"Initial Consultation"

​
description
string | null
required

Service description

Example:

"This is a sample service"

​
type
string | null
required

Service type

Example:

"Other"

​
code
string | null
required

Service code

Example:

"ABC123"

​
duration
number | null
required

Service duration in minute

Example:

90

​
unit
enum<string> | null
required

Service unit

Available options:
Hour,
Each
Example:

"Hour"

​
pricing
number | null
required

Service unit price in dollar

Example:

193.99

​
taxType
required

Tax type, check Splose support for more info

Available options:
STANDARD,
ZERO,
EXEMPT,
REDUCED
Example:

"STANDARD"

​
providerTravelItemCode
string | null
required

Provider travel item code

Example:

""

​
providerTravelPricing
number | null
required

Provider travel item pricing

Example:

0

​
providerTravelNonLabourCostsItemCode
string | null
required

Provider travel non labour cost item code

Example:

""

​
providerTravelNonLabourCostsPricing
number | null
required

Provider travel non labour cost item pricing

Example:

0

​
serviceTags
string[]
required

Service tags

Example:
["NDIS"]
​
deletedAt
required

Object archived date time

Example:

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

​
allowProviderTravel
boolean | null
default:false

Whether provider travel is enabled

​
allowProviderTravelNonLabourCosts
boolean | null
default:false

Whether provider travel non labour cost is enabled

​
archived
boolean | null
default:false

Whether the service has been archived

​
createdAt

Object creation date time

Example:

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

​
updatedAt

Object update date time

Example:

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