The following endpoints are related to the team member resource in the Calendsa platform.
List Team Members
GET
/api/v1/team-members
Retrieve a list of all team members.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Request Example
Responses
200: OK
List of team members received successfully
401: Unauthorized
Authorization information missing, expired or invalid
Find Team Member
GET
/api/v1/team-members/{id}
Retrieve a specific team member by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the team member to get
Request Example
Responses
200: OK
Team member received successfully
401: Unauthorized
Authorization information missing, expired or invalid
404: Not found
Resource not found
Update Team Member
PATCH
/api/v1/team-members/{id}
Update a specific team member 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 team member to update
Body
firstName
string
First name of the team member
lastName
string
Last name of the team member
role
string
BASIC | LOW | MEDIUM | HIGH | OWNER
phoneNumber
string | null
Phone number of the team member
address
string | null
Address of the team members
providesServices
boolean
True means that the team member will provide services and is available on the booking page.
internalNotes
string | null
Additional information about this team member
useBusinessHours
boolean
True means the team member's availability is as specified in the businessHours property of the business. False means the availability is determined by the team member's workingHours property setting.
workingHours
WorkHours[]
The range of hours each day of the week that the team member is available for booking. By default, they are initialized to be the same as the businessHours property of the business.
tags
string[]
Tags for the team member
assignedServiceIds
string[]
Represents those services who are provided by this team member
Request Example
Responses
200: OK
Team member updated successfully
401: Unauthorized
Authorization information missing, expired or invalid