Service
API Docs
The following endpoints are related to the service resource in the Calendsa platform.
/api/v1/services
Retrieve a list of all services.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Request Example
Responses
200: OK
List of services received successfully
401: Unauthorized
Authorization information missing, expired or invalid
/api/v1/services
Create a new service.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Content-Type*
string
application/json
Body
serviceCategoryId*
string
ID of the service category
name*
string
Name of the service
tagline
string | null
Catchphrase or slogan of the service
description
string | null
Text description for the service
visibleOnBookingPage
boolean
If false, the service is not available to customers for booking
locationType
string
BUSINESS | CLIENT | GOOGLE_MEET | MICROSOFT_TEAMS | ZOOM_VIDEO
pricingType
string
FIXED_PRICE | STARTING_AT | HOURLY | FREE | PRICE_VARIES | CALL_US | PRICE_NOT_SET
price
float
Monetary price of the service
duration
Duration
Length of the service represented in numbers of days, hours and minutes
useBuffers
boolean
Enable buffer times before/after an appointment for this service
preBuffer
Duration
Buffer time before an appointment for this service can start
postBuffer
Duration
Buffer time after an appointment for this service ends, and before the next customer appointment can be booked
internalNotes
string | null
Additional information about this service
maximumNumberOfAttendees
integer
Maximum number of customers allowed in a service.
tags
string[]
Tags for the service
assignedTeamMemberIds
string[]
Represents those team members who provide this service
Request Example
Responses
201: Created
Service created successfully
401: Unauthorized
Authorization information missing, expired or invalid
/api/v1/services/{id}
Retrieve a specific service by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the service to get
Request Example
Responses
200: OK
Service category received successfully
401: Unauthorized
Authorization information missing, expired or invalid
404: Not found
Resource not found
/api/v1/services/{id}
Update a specific service by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Content-Type*
string
application/json
Path
id*
string
ID of the service to update
Body
serviceCategoryId
string
ID of the service category
name
string
Name of the service
tagline
string | null
Catchphrase or slogan of the service
description
string | null
Text description for the service
visibleOnBookingPage
boolean
If false, the service is not available to customers for booking
locationType
string
BUSINESS | CLIENT | GOOGLE_MEET | MICROSOFT_TEAMS | ZOOM_VIDEO
pricingType
string
FIXED_PRICE | STARTING_AT | HOURLY | FREE | PRICE_VARIES | CALL_US | PRICE_NOT_SET
price
float
Monetary price of the service
duration
Duration
Length of the service represented in numbers of days, hours and minutes
useBuffers
boolean
Enable buffer times before/after an appointment for this service
preBuffer
Duration
Buffer time before an appointment for this service can start
postBuffer
Duration
Buffer time after an appointment for this service ends, and before the next customer appointment can be booked
internalNotes
string | null
Additional information about this service
maximumNumberOfAttendees
integer
Maximum number of customers allowed in a service.
tags
string[]
Tags for the service
assignedTeamMemberIds
string[]
Represents those team members who provide this service
Request Example
Responses
200: OK
Service updated successfully
401: Unauthorized
Authorization information missing, expired or invalid
404: Not found
Resource not found
/api/v1/services/{id}
Delete a specific service by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the service to delete
Request Example
Responses
204: No content
Service deleted successfully
401: Unauthorized
Authorization information missing, expired or invalid
404: Not found
Resource not found