For AI agents: visit https://www.bessy.academy/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Bessy Academy
Developers
What's new
1.26.30
Bessy.nl >
Developers
Bessy.nl >
1.26.30
Bessy Academy
Developers
What's new
My Requests
JUMP TO
My Requests
Getting started
Getting started
Bessy Public API
Sessions
Create session
get
Destroy session
get
Clients
Find a client
get
Create a client
post
Update a client
post
Locations
Get a location
get
Find a location
get
List locations
get
Create a location
post
Update location
post
Add client to location
post
Remove client from location
post
Location Sources
Get location source
get
List location sources
get
Location Data
List all ISO countries
get
Get the ISO country code for a given country name
get
Get location data for GPS coordinates
get
Get location data for provided address components
get
Tasks
Get task
get
Get task note
get
List task notes
get
List task events
get
Create task note
post
Get plan portal URL
get
Update task note
post
Create task
post
Create all
post
Update task
post
Remove task
post
List tasks
get
Send task email
post
Task Events
List task status transitions
get
List task planning suggestion transitions
get
List task emails
get
List task messages
get
Task Notes
Remove task note
post
Task Status
Open task
post
Cancel task
post
Report task issue
post
Started driving
post
Started working
post
Complete task
post
Billed task
post
Task Tags
Add tag to task
post
Remove tag from task
post
Task Access
Add group to task
post
Remove group from task
post
Add user to task
post
Remove user from task
post
Task Type Categories
Get task type category
get
List task type categories
get
Create task type category
post
Update task type category
post
Remove task type category
post
Task Types
Get task type
get
List task types
get
Create task type
post
Update task type
post
Remove task type
post
Task Issues
Get task issue type
get
List task issue types
get
Get task issue category
get
List task issue categories
get
Tags
Get tag
get
List tags
get
Create tag
post
Update tag
post
Remove tag
post
Users
Get user
get
List users
get
Create user
post
Update user
post
Files
List files
get
Create file
post
PDFs
Get PDF
get
List PDF templates
get
Email Templates
Get Email template
get
List Email templates
get
User Absence
Get user absence
get
List user absences
get
Create user absence
post
Update user absence
post
Remove user absence
post
Absence Types
Get absence type
get
List absence types
get
Create an absence type
post
Update an absence type
post
Remove an absence type
post
Checklists
List checklists
get
Get checklist data
get
List checklist data
get
User Availability
Get user availability
get
List user availability
get
Create user availability
post
Update user availability
post
Remove user availability
post
Groups
Get group
get
List groups
get
Create group
post
Update group
post
Add user to group
post
Remove user from group
post
Suggestions
Get a suggestion
get
Request a suggestion for a task
post
Cancel a suggestion
post
Timeslots
Pick a suggestion timeslot
post
Shift Breaks
Get shift break
get
List shift breaks
get
Create shift break
post
Update shift break
post
Remove shift break
post
Planning Configs
Get planning config
get
List planning configs
get
Create planning config
post
Update planning config
post
Remove planning config
post
Shift Templates
Get shift template
get
List shift templates
get
Create shift template
post
Update shift template
post
Remove shift template
post
Base Shifts
Get base shift
get
List base shifts
get
Create base shift
post
Update base shift
post
Remove base shift
post
Add base shift date exception
post
Remove base shift date exception
post
Virtual shifts
List shifts
get
Guides
API key
Logging calls to developers portal
Webhook Signature
How to Webhook test
Shifts API guide
Send emails via the API
Powered by
••••••afb7
Endpoint
Method
Status
User Agent
