Skip to main content
GET
/
services
/
{service}
cURL
curl --request GET \
  --url https://api.caspen.com/v1/services/{service}
{
  "id": "<string>",
  "category_id": "<string>",
  "progress_note_template_id": "<string>",
  "appointment_notification_set_id": "<string>",
  "tax_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "item_code": "<string>",
  "duration": 123,
  "buffer_before_duration": 123,
  "buffer_after_duration": 123,
  "price": 123,
  "price_unit": "<string>",
  "online_booking": true,
  "practitioner_ids": [
    "<string>"
  ],
  "location_ids": [
    "<string>"
  ],
  "tag_ids": [
    "<string>"
  ],
  "created_at": "<string>"
}

Path Parameters

​
service
string
required

The service ID

Response

ServiceResource

​
id
string

The service's unique identifier.

​
category_id
string

The service category identifier.

​
progress_note_template_id
string | null

The progress note template identifier.

​
appointment_notification_set_id
string | null

The appointment notification set identifier.

​
tax_id
string

The tax identifier.

​
name
string

The service's name.

​
description
string | null

The service's description.

​
item_code
string | null

The service's item code.

​
duration
integer

The service duration in minutes.

​
buffer_before_duration
integer

The buffer time before the service in minutes.

​
buffer_after_duration
integer

The buffer time after the service in minutes.

​
price
number

The service price.

​
price_unit
string

The service price unit.

​
online_booking
boolean

Whether online booking is enabled for this service.

​
practitioner_ids
string[]

The IDs of practitioners who can provide this service.

​
location_ids
string[]

The IDs of locations where this service is available.

​
tag_ids
string[]

The IDs of tags attached to this service.

​
created_at
string

The timestamp when the service was created (ISO 8601).