# Bessy Documentation

> Documentation for Bessy

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Welkom in de Bessy Academy](https://www.bessy.academy/docs/dit-leer-je-allemaal-in-de-bessy-academy.md)
- [Afspraken handmatig aanmaken](https://www.bessy.academy/docs/afspraak-aanmaken-backoffice.md)
- [Afspraken importeren](https://www.bessy.academy/docs/afspraken-importeren.md)
- [Inplannen](https://www.bessy.academy/docs/afspraak-inplannen.md)
- [Planning wijzigen](https://www.bessy.academy/docs/backoffice-planning-wijzigen.md)
- [Plannen in batch](https://www.bessy.academy/docs/plannen-in-batch.md)
- [Afspraak verwerken](https://www.bessy.academy/docs/afspraak-verwerken.md)
- [Planbord](https://www.bessy.academy/docs/backoffice-planbord.md)
- [Filteroverzicht](https://www.bessy.academy/docs/afspraak-overzicht.md)
- [Afspraaktoegang](https://www.bessy.academy/docs/afspraaktoegang.md)
- [Exporteren](https://www.bessy.academy/docs/afspraken-exporten.md)
- [Locaties en relaties](https://www.bessy.academy/docs/backoffice-locaties-en-relaties.md)
- [Registreren en rapporteren](https://www.bessy.academy/docs/backoffice-checklist.md)
- [Werktijden](https://www.bessy.academy/docs/werktijden.md)
- [Afwezigheid](https://www.bessy.academy/docs/backoffice-afwezigheid-registreren.md)
- [Plannen in beschikbaarheid](https://www.bessy.academy/docs/backoffice-plannen-in-beschikbaarheid.md)
- [Shifts](https://www.bessy.academy/docs/shifts.md)
- [Zoeken in Bessy](https://www.bessy.academy/docs/backoffice-zoeken-in-bessy.md)
- [App installeren](https://www.bessy.academy/docs/app-installeren.md)
- [Inloggen](https://www.bessy.academy/docs/app-inloggen.md)
- [Afspraak uitvoeren in de app](https://www.bessy.academy/docs/app-afspraak-uitvoeren.md)
- [Werkzaamheden registreren](https://www.bessy.academy/docs/app-checklist.md)
- [Afspraken inplannen](https://www.bessy.academy/docs/app-afspraak-plannen.md)
- [Afspraken in de buurt](https://www.bessy.academy/docs/app-afspraken-in-de-buurt.md)
- [App configureren](https://www.bessy.academy/docs/app-configureren.md)
- [Het klantportaal](https://www.bessy.academy/docs/klantportaal.md)
- [Afspraaktypen](https://www.bessy.academy/docs/configuratie-afspraaktype.md)
- [Verlofsoorten](https://www.bessy.academy/docs/configuratie-verlofsoorten.md)
- [Tags](https://www.bessy.academy/docs/configuratie-tags.md)
- [Planbord](https://www.bessy.academy/docs/configuratie-planbord.md)
- [Shifts](https://www.bessy.academy/docs/configuratie-shifts.md)
- [Bedrijfsgegevens](https://www.bessy.academy/docs/configuratie-bedrijfsgegevens.md)
- [Abonnement](https://www.bessy.academy/docs/configuratie-abonnement.md)
- [Gebruikers](https://www.bessy.academy/docs/configuratie-gebruikers.md)
- [Groepen ](https://www.bessy.academy/docs/configuratie-groepen.md)
- [Vertreklocaties](https://www.bessy.academy/docs/configuratie-vertreklocaties.md)
- [Teams](https://www.bessy.academy/docs/configuratie-teams.md)
- [Backoffice sidebar](https://www.bessy.academy/docs/configuratie-backoffice-sidebar.md)
- [Checklist aanmaken](https://www.bessy.academy/docs/configuratie-checklist.md)
- [Meldingen](https://www.bessy.academy/docs/configuratie-buitendienst-meldingen.md)
- [Buitendienst app](https://www.bessy.academy/docs/configuratie-buitendienst-app.md)
- [Klantportaal](https://www.bessy.academy/docs/configuratie-klantportaal.md)
- [E-mails](https://www.bessy.academy/docs/configuratie-emails.md)
- [SMS](https://www.bessy.academy/docs/configuratie-sms.md)
- [PDF documenten](https://www.bessy.academy/docs/configuratie-pdf-documenten.md)
- [Planning configuratie](https://www.bessy.academy/docs/configuratie-planbot.md)
- [Automations](https://www.bessy.academy/docs/configuratie-automations.md)
- [API](https://www.bessy.academy/docs/configuratie-api.md)
- [Outlook agenda](https://www.bessy.academy/docs/configuratie-outlook-agenda.md)
- [Google agenda](https://www.bessy.academy/docs/configuratie-google-agenda.md)
- [Bessy Connect](https://www.bessy.academy/docs/configuratie-bessy-connect.md)
- [Afspraakstatus](https://www.bessy.academy/docs/begrippen-afspraakstatus.md)
- [Afspraken, afspraaktypen en categorieën](https://www.bessy.academy/docs/begrippen-afspraken.md)
- [Locaties en relaties](https://www.bessy.academy/docs/begrippen-locaties-en-relaties.md)
- [Planbot AI](https://www.bessy.academy/docs/planbot-ai.md)
- [Shifts, templates en het shiftbord](https://www.bessy.academy/docs/shifts-templates-en-het-shiftbord.md)
- [Speling](https://www.bessy.academy/docs/begrippen-speling.md)
- [Tags](https://www.bessy.academy/docs/begrippen-tags.md)
- [Automations](https://www.bessy.academy/docs/bestpractice-automations.md)
- [Tags inzetten](https://www.bessy.academy/docs/bestpractice-tags.md)
- [Toegang beheren](https://www.bessy.academy/docs/bestpractice-toegang-beheren.md)
- [Werken met ZZP'ers](https://www.bessy.academy/docs/bestpractice-werken-met-zzpers.md)
- [Werken met snelheidsfactoren](https://www.bessy.academy/docs/werken-met-snelheidsfactoren.md)
- [Aankomstbericht met ETA](https://www.bessy.academy/docs/aankomstbericht-met-eta.md)
- [Afspraaktypen en categorieën indelen](https://www.bessy.academy/docs/afspraaktypen-en-categorieën-indelen.md)
- [Statuspagina](https://www.bessy.academy/docs/statuspagina.md)
- [Onboarding](https://www.bessy.academy/docs/onboarding-overview.md)
- [Onboarding](https://www.bessy.academy/docs/onboarding.md)
- [Jouw Bessy inrichten](https://www.bessy.academy/docs/onboarding-jouw-bessy-inrichten.md)
- [Afspraak aanmaken](https://www.bessy.academy/docs/onboarding-taak-aanmaken.md)
- [Afspraken inplannen & bevestigen](https://www.bessy.academy/docs/onboarding-taak-inplannen-bevestigen.md)
- [Afspraak uitvoeren in de app](https://www.bessy.academy/docs/onboarding-taak-uitvoeren-in-de-app.md)
- [Afspraak informatie registreren](https://www.bessy.academy/docs/onboarding-taak-informatie-registreren.md)
- [Handelingen automatiseren](https://www.bessy.academy/docs/onboarding-handelingen-automatiseren.md)
- [Je bent er klaar voor!](https://www.bessy.academy/docs/onboarding-klaar.md)
- [Contact](https://www.bessy.academy/docs/contact.md)
- [Pre-launch](https://www.bessy.academy/docs/pre-launch.md)
- [Early access](https://www.bessy.academy/docs/early-access.md): Meld je aan en krijg als eerste toegang tot Bessy Planner voor WhatsApp

## API Reference
- [My Requests](https://www.bessy.academy/reference/my-requests.md): Set up the welcome page for your API to help users make their first call.
- [Getting started](https://www.bessy.academy/reference/getting-started-with-the-bessy-developers-portal.md): How to get started with the Bessy Public API and this developers portal
- [Create session](https://www.bessy.academy/reference/get_session-create.md): This endpoint allows you to create a session. Provide the API key as a request parameter.
- [Destroy session](https://www.bessy.academy/reference/get_session-destroy.md): This endpoint destroys a session by providing the Session id in the header.
- [Find a client](https://www.bessy.academy/reference/get_client-find.md): Retrieves a client by email address or checks if a client exists.
- [Create a client](https://www.bessy.academy/reference/post_client-create.md): Creates a client using the provided details.
- [Update a client](https://www.bessy.academy/reference/post_client-update.md): Updates a client's details.
- [Get a location](https://www.bessy.academy/reference/get_location-get.md): This endpoint retrieves a location based on the provided location ID.
- [Find a location](https://www.bessy.academy/reference/get_location-find-one.md): This endpoint retrieves a location using a selector variable. At least one of the following parameters is required: name, clientReference, or a combination of postalCode and streetNumber.
- [List locations](https://www.bessy.academy/reference/get_location-list.md): This endpoint retrieves a list of locations based on various parameters.  At least one of `_id`, `sourceId`, `_createdAt` or `_updatedAt` must be provided.
- [Create a location](https://www.bessy.academy/reference/post_location-create.md): This endpoint can be used to create a location. If a client ID is provided, the location will automatically be assigned to this client.
- [Update location](https://www.bessy.academy/reference/post_location-update.md): This endpoint can be used to update a location.
- [Add client to location](https://www.bessy.academy/reference/post_location-add-client.md): This endpoint can be used to add a client to a work location.
- [Remove client from location](https://www.bessy.academy/reference/post_location-remove-client.md): This endpoint can be used to remove a client from a work location.
- [Get location source](https://www.bessy.academy/reference/get_location-source-get.md): This endpoint retrieves a location source. You must provide a session ID in the header and a location ID in the body.
- [List location sources](https://www.bessy.academy/reference/get_location-source-list.md): This endpoint retrieves a list of location sources. You must provide a session ID in the header.
- [List all ISO countries](https://www.bessy.academy/reference/get_location-iso-countries-list.md): This endpoint returns a list of all ISO country codes along with their official names.
- [Get the ISO country code for a given country name](https://www.bessy.academy/reference/get_location-iso-countries-get.md): This endpoint retrieves the ISO 3166-1 alpha-2 country code for the specified country name in Dutch.
- [Get location data for GPS coordinates](https://www.bessy.academy/reference/get_location-gps-location-data.md): This endpoint retrieves location data based on the provided GPS coordinates (latitude and longitude).
- [Get location data for provided address components](https://www.bessy.academy/reference/get_location-address-location-data.md): This endpoint retrieves location data based on the provided address components. Either `place + street + streetNumber` or `postalCode + streetNumber` must be provided.
- [Get task](https://www.bessy.academy/reference/get_task-get.md): This endpoint retrieves a task using its ID. You must provide a session ID in the header and a task ID in the body.
- [Get task note](https://www.bessy.academy/reference/get_task-note-get.md): This endpoint can be used to get a task note. In the request you provide a session ID in the header and note ID in the body.
- [List task notes](https://www.bessy.academy/reference/get_task-note-list.md): This endpoint can be used to get a list of task notes. At least one of `_id`, `taskIds`, `_createdAt` or `_updatedAt` must be provided.
- [List task events](https://www.bessy.academy/reference/get_task-event-list.md): This endpoint can be used to retrieve all events of a task. In the request you provide a session ID in the header and a task ID in the body.
- [Create task note](https://www.bessy.academy/reference/post_task-note-create.md): This endpoint can be used to create a task note. If successful, a note model will be returned to the caller.
- [Get plan portal URL](https://www.bessy.academy/reference/get_task-get-plan-portal-url.md): This endpoint can be used to retrieve the URL to the planning portal for a specific task ID and user ID. In the request you provide a session ID in the header and a task ID and user ID in the body. The URL to the planning portal will be returned to the caller.
- [Update task note](https://www.bessy.academy/reference/post_task-note-update.md): This endpoint can be used to update a task note.
- [Create task](https://www.bessy.academy/reference/post_task-create.md): This endpoint can be used to create a task. A client and location can also be set in this request. If successful, a task ID will be returned to the caller.
- [Create all](https://www.bessy.academy/reference/post_task-create-all.md): This endpoint creates a task together with the task’s client and location. If the client or location already exists, the one already stored will be taken.
- [Update task](https://www.bessy.academy/reference/post_task-update.md): This endpoint can be used to update a task. You must provide a session ID in the header and a task ID in the body.
- [Remove task](https://www.bessy.academy/reference/post_task-remove.md): This endpoint can be used to remove a task. It is only allowed to remove cancelled tasks.
- [List tasks](https://www.bessy.academy/reference/get_task.md): This endpoint retrieves a list of tasks. At least one of `ids`, `status`, `plannedDate` or `_updatedAt` must be provided.
- [Send task email](https://www.bessy.academy/reference/post_task-email-send.md): This endpoint sends a task email using a mail template. The email is generated from the selected template and task data, and sent to one or more recipient aliases.
- [List task status transitions](https://www.bessy.academy/reference/get_task-status-transition-list.md): This endpoint can be used to get a list of task status transitions.  At least one of `_id`, `taskIds` or `_createdAt` must be provided.
- [List task planning suggestion transitions](https://www.bessy.academy/reference/get_task-suggestion-transition-list.md): This endpoint can be used to get a list of task planning suggestion transitions. At least one of `_id`, `taskIds`, `_createdAt` or `_updatedAt` must be provided.
- [List task emails](https://www.bessy.academy/reference/get_task-email-list.md): This endpoint can be used to get a list of task emails.  At least one of `_id`, `taskIds`, `_createdAt` or `_updatedAt` must be provided.
- [List task messages](https://www.bessy.academy/reference/get_task-message-list.md): This endpoint can be used to get a list of task messages. At least one of `_id`, `taskIds`, `_createdAt` or `_updatedAt` must be provided.
- [Remove task note](https://www.bessy.academy/reference/post_task-note-remove.md): This endpoint can be used to remove a task note.
- [Open task](https://www.bessy.academy/reference/post_task-status-open.md): This endpoint can be used to set the status of a task to open.
- [Cancel task](https://www.bessy.academy/reference/post_task-status-cancelled.md): This endpoint can be used to cancel a task. One is only allowed to cancel open, concept, or canceled tasks.
- [Report task issue](https://www.bessy.academy/reference/post_task-status-reported-issue.md): This endpoint can be used to report a task issue, the status of the task will be changed to 'reported-issue'. In the request you provide a session ID in the header and a task ID in the body.
- [Started driving](https://www.bessy.academy/reference/post_task-status-started-driving.md): This endpoint can be used to add a ‘started driving’ transition to a task. In the request you provide a session ID in the header and a task ID in the body.
- [Started working](https://www.bessy.academy/reference/post_task-status-started-working.md): This endpoint can be used to add a ‘started working’ transition to a task. In the request you provide a session ID in the header and a task ID in the body.
- [Complete task](https://www.bessy.academy/reference/post_task-status-completed.md): This endpoint can be used to add a ‘completed’ transition to a task and to set the status of the task to completed. In the request you provide a session ID in the header and a task ID in the body.
- [Billed task](https://www.bessy.academy/reference/post_task-status-billed.md): This endpoint can be used to add a ‘billed’ transition to a task. In the request you provide a session ID in the header and a task ID in the body.
- [Add tag to task](https://www.bessy.academy/reference/post_task-add-tag.md): This endpoint can be used to add a tag to a task.
- [Remove tag from task](https://www.bessy.academy/reference/post_task-remove-tag.md): This endpoint can be used to remove a tag from a task.
- [Add group to task](https://www.bessy.academy/reference/post_task-add-group.md): This endpoint can be used to add a group to a task.
- [Remove group from task](https://www.bessy.academy/reference/post_task-remove-group.md): This endpoint can be used to remove a group from a task.
- [Add user to task](https://www.bessy.academy/reference/post_task-add-user.md): This endpoint can be used to add a user to a task.
- [Remove user from task](https://www.bessy.academy/reference/post_task-remove-user.md): This endpoint can be used to remove a user from a task.
- [Get task type category](https://www.bessy.academy/reference/get_task-type-category-get.md): This endpoint can be used to retrieve a task type category. In the request you provide a session ID in the header and a task type category ID in the query.
- [List task type categories](https://www.bessy.academy/reference/get_task-type-category-list.md): This endpoint can be used to list all registered task type categories. By calling this endpoint with a valid session ID in the header, you will receive a list of task type categories.
- [Create task type category](https://www.bessy.academy/reference/post_task-type-category-create.md): This endpoint can be used to create a task type category. In the request you provide a session ID in the header and task type category details in the body.
- [Update task type category](https://www.bessy.academy/reference/post_task-type-category-update.md): This endpoint can be used to update a task type category. In the request you provide a session ID in the header and task type category details in the body.
- [Remove task type category](https://www.bessy.academy/reference/post_task-type-category-remove.md): Use this endpoint to remove a task type category. A task type category can only be removed if its task types do not have any associated tasks.
- [Get task type](https://www.bessy.academy/reference/get_task-type-get.md): This endpoint can be used to retrieve a task type. In the request you provide a session ID in the header and a task type ID in the query.
- [List task types](https://www.bessy.academy/reference/get_task-type-list.md): This endpoint can be used to list all registered task types. By calling this endpoint with a valid session ID in the header, you will receive a list of task types.
- [Create task type](https://www.bessy.academy/reference/post_task-type-create.md): This endpoint can be used to create a task type. In the request you provide a session ID in the header and task type details in the body.
- [Update task type](https://www.bessy.academy/reference/post_task-type-update.md): This endpoint can be used to update a task type. In the request you provide a session ID in the header and task type details in the body.
- [Remove task type](https://www.bessy.academy/reference/post_task-type-remove.md): Use this endpoint to remove a task type. A task type can only be removed if it does not have any associated tasks.
- [Get task issue type](https://www.bessy.academy/reference/get_task-issue-types-get.md): This endpoint can be used to retrieve a task issue type. In the request you provide a session ID in the header and a task issue type ID in the query.
- [List task issue types](https://www.bessy.academy/reference/get_task-issue-types-list.md): This endpoint can be used to list all registered task issue types. By calling this endpoint with a valid session ID in the header, you will receive a list of task issue types.
- [Get task issue category](https://www.bessy.academy/reference/get_task-issue-categories-get.md): This endpoint can be used to retrieve a task issue category. In the request you provide a session ID in the header and a task issue category ID in the query.
- [List task issue categories](https://www.bessy.academy/reference/get_task-issue-categories-list.md): This endpoint can be used to list all registered task issue categories. By calling this endpoint with a valid session ID in the header, you will receive a list of task issue categories.
- [Get tag](https://www.bessy.academy/reference/get_tag-get.md): This endpoint can be used to get a tag. In the request you provide a session ID in the header and tag ID in the body.
- [List tags](https://www.bessy.academy/reference/get_tag-list.md): This endpoint can be used to get a list of all tags. In the request you provide a session ID in the header.
- [Create tag](https://www.bessy.academy/reference/post_tag-create.md): This endpoint can be used to create a tag. In the request you provide a session ID in the header and tag details in the body.
- [Update tag](https://www.bessy.academy/reference/post_tag-update.md): This endpoint can be used to update a tag. In the request you provide a session ID in the header and tag details in the body.
- [Remove tag](https://www.bessy.academy/reference/post_tag-remove.md): Use this endpoint to remove a tag. A tag can only be removed if it is not associated with any tasks, shift templates, or user availabilities.
- [Get user](https://www.bessy.academy/reference/get_user-get.md): This endpoint can be used to retrieve a user. In the request you provide a session ID in the header and a user ID in the body.
- [List users](https://www.bessy.academy/reference/get_user-list.md): This endpoint can be used to get a list of all users. In the request you provide a session ID in the header.
- [Create user](https://www.bessy.academy/reference/post_user-create.md): This endpoint can be used to create a user. In the request you provide a session ID in the header and user details in the body.
- [Update user](https://www.bessy.academy/reference/post_user-update.md): This endpoint can be used to update a user. Only provided fields are updated.
- [List files](https://www.bessy.academy/reference/get_files.md): This endpoint can be used to list files that have been uploaded to the system.
- [Create file](https://www.bessy.academy/reference/post_file-create.md): This endpoint can be used to create an attachment that can be added to a new or existing task.
- [Get PDF](https://www.bessy.academy/reference/get_pdf-get.md): This endpoint allows you to generate and download a PDF.
- [List PDF templates](https://www.bessy.academy/reference/get_template-pdf-list.md): This endpoint allows you to list the available PDF templates.
- [Get Email template](https://www.bessy.academy/reference/get_template-email-get.md): This endpoint can be used to get an email template. In the request you provide a session ID in the header and note ID in the body.
- [List Email templates](https://www.bessy.academy/reference/get_template-email-list.md): This endpoint allows you to list the available email templates.
- [Get user absence](https://www.bessy.academy/reference/get_user-absence-get.md): This endpoint can be used to get user absence. In the request you provide a session ID in the header.
- [List user absences](https://www.bessy.academy/reference/get_user-absence-list.md): This endpoint can be used to get a list of user absences.
- [Create user absence](https://www.bessy.academy/reference/post_user-absence-create.md): This endpoint can be used to create a user absence. If successful, an absence model will be returned to the caller.
- [Update user absence](https://www.bessy.academy/reference/post_user-absence-update.md): This endpoint can be used to update a user absence.
- [Remove user absence](https://www.bessy.academy/reference/post_user-absence-remove.md): This endpoint can be used to remove a user absence.
- [Get absence type](https://www.bessy.academy/reference/get_user-absence-types-get.md): This endpoint can be used to retrieve an absence type. In the request you provide a session ID in the header and an absence type ID in the body.
- [List absence types](https://www.bessy.academy/reference/get_user-absence-types-list.md): This endpoint can be used to list all registered absence types.
- [Create an absence type](https://www.bessy.academy/reference/post_user-absence-types-create.md): This endpoint can be used to create an absence type.
- [Update an absence type](https://www.bessy.academy/reference/post_user-absence-types-update.md): This endpoint can be used to update an absence type.
- [Remove an absence type](https://www.bessy.academy/reference/post_user-absence-types-remove.md): This endpoint can be used to remove an absence type.
- [List checklists](https://www.bessy.academy/reference/get_checklist-list.md): This endpoint allows you to list the available checklists.
- [Get checklist data](https://www.bessy.academy/reference/get_checklist-data.md): This endpoint allows you to get the data from a filled checklist.
- [List checklist data](https://www.bessy.academy/reference/get_checklist-data-list.md): This endpoint retrieves a list of filled checklists. At least one of `itemIds`, `taskIds` or `checklistIds` must be provided.
- [Get checklist](https://www.bessy.academy/reference/get_checklist-get.md): Retrieves the latest version of a checklist, including its steps, fields and field configuration
- [Create checklist data](https://www.bessy.academy/reference/post_checklist-data-create.md): Creates a new filled-in checklist for a task using the latest version of the checklist. Field IDs must correspond to fields returned by the /checklist/get endpoint. When the checklist does not allow multiple instances, only one checklist data record for the same task and checklist may be created. The checklist is automatically marked as completed when all required fields contain a value.
- [Update checklist data](https://www.bessy.academy/reference/post_checklist-data-update.md): Updates fields of an existing checklist data record. Only submitted fields are updated. Other previously stored checklist values remain unchanged. Field IDs are validated against the checklist version used when the checklist data record was created. A field value may be set to null to clear the existing value. The checklist is marked as completed when all required fields contain a value. If a required value is cleared from a completed checklist, the checklist is marked as open again.
- [Remove checklist data](https://www.bessy.academy/reference/post_checklist-data-remove.md): Removes an existing checklist data record
- [Get user availability](https://www.bessy.academy/reference/get_user-availability-get.md): This endpoint can be used to get user availability. In the request you provide a session ID in the header and availability ID in the query.
- [List user availability](https://www.bessy.academy/reference/get_user-availability-list.md): This endpoint can be used to get a list of user availabilities.  At least one of `_id`, `startDate`, `endDate`, `userIds`, `taskTypeIds` or `tagIds` must be provided.
- [Create user availability](https://www.bessy.academy/reference/post_user-availability-create.md): This endpoint can be used to create a user availability. If successful, an availability model will be returned to the caller. NOTE: You must provide either taskTypeIds OR tagIds OR both
- [Update user availability](https://www.bessy.academy/reference/post_user-availability-update.md): This endpoint can be used to update a user availability. In the request, you provide a session ID in the header and availability details in the body. User availability should have taskTypeIds OR tagIds set (OR a combination of both). WARNING : You cannot set both taskTypeIds AND tagIds to null.
- [Remove user availability](https://www.bessy.academy/reference/post_user-availability-remove.md): This endpoint can be used to remove a user availability.
- [Get group](https://www.bessy.academy/reference/get_group-get.md): This endpoint can be used to get a group. In the request, you provide a session ID in the header and group id in the body.
- [List groups](https://www.bessy.academy/reference/get_group-list.md): This endpoint can be used to get a list of all groups. In the request you provide a session ID in the header.
- [Create group](https://www.bessy.academy/reference/post_group-create.md): This endpoint can be used to create a group. In the request, you provide a session ID in the header and group details in the body.
- [Update group](https://www.bessy.academy/reference/post_group-update.md): This endpoint can be used to update a group. In the request, you provide a session ID in the header and group details in the body.
- [Add user to group](https://www.bessy.academy/reference/post_group-add-user.md): This endpoint can be used to add a user to a group.
- [Remove user from group](https://www.bessy.academy/reference/post_group-remove-user.md): This endpoint can be used to remove a user from a group.
- [Get a suggestion](https://www.bessy.academy/reference/get_suggestion-get.md): This endpoint can be used to get a suggestion. Either 'taskId' or 'suggestionId' is required.
- [Request a suggestion for a task](https://www.bessy.academy/reference/post_suggestion-request.md): This endpoint can be used to request a suggestion for a task.
- [Cancel a suggestion](https://www.bessy.academy/reference/post_suggestion-cancel.md): This endpoint can be used to cancel the suggestion for a task.
- [Pick a suggestion timeslot](https://www.bessy.academy/reference/post_timeslot-pick.md): This endpoint can be used to pick a suggestion timeslot for a task.
- [Get shift break](https://www.bessy.academy/reference/get_shift-break-get.md): This endpoint can be used to retrieve a shift break. In the request you provide a session ID in the header and a shift break ID in the query.
- [List shift breaks](https://www.bessy.academy/reference/get_shift-break-list.md): This endpoint can be used to list all registered shift breaks. By calling this endpoint with a valid session ID in the header, you will receive a list of shift breaks.
- [Create shift break](https://www.bessy.academy/reference/post_shift-break-create.md): This endpoint can be used to create a shift break. In the request you provide a session ID in the header and shift break details in the body.
- [Update shift break](https://www.bessy.academy/reference/post_shift-break-update.md): This endpoint can be used to update a shift break. In the request you provide a session ID in the header and shift break details in the body.
- [Remove shift break](https://www.bessy.academy/reference/post_shift-break-remove.md): Removes a shift break. A shift break can only be removed if it has no associated planning configs. If planning configs are linked, the request will fail with reason existing-planning-configs.
- [Get planning config](https://www.bessy.academy/reference/get_planning-config-get.md): Retrieve a planning config by ID. Provide a session ID in the header and a planning config ID in the query.
- [List planning configs](https://www.bessy.academy/reference/get_planning-config-list.md): Retrieve all registered planning configs. Provide a valid session ID in the header.
- [Create planning config](https://www.bessy.academy/reference/post_planning-config-create.md): Create a new planning config. Provide a session ID in the header and the planning config details in the request body.
- [Update planning config](https://www.bessy.academy/reference/post_planning-config-update.md): Update an existing planning config. Provide a session ID in the header and the updated fields in the request body.
- [Remove planning config](https://www.bessy.academy/reference/post_planning-config-remove.md): Removes a planning config. A planning config can only be removed if it has no associated shift templates or base shifts. If shift templates are linked, the request will fail with reason existing-shift-templates. If base shifts are linked, the request will fail with reason existing-base-shifts.
- [Get shift template](https://www.bessy.academy/reference/get_shift-template-get.md): This endpoint can be used to retrieve a shift template. In the request you provide a session ID in the header and a shift template ID in the query.
- [List shift templates](https://www.bessy.academy/reference/get_shift-template-list.md): This endpoint can be used to list all registered shift templates. By calling this endpoint with a valid session ID in the header, you will receive a list of shift templates.
- [Create shift template](https://www.bessy.academy/reference/post_shift-template-create.md): This endpoint can be used to create a shift template. In the request you provide a session ID in the header and shift template details in the body.
- [Update shift template](https://www.bessy.academy/reference/post_shift-template-update.md): This endpoint can be used to update a shift template. In the request you provide a session ID in the header and shift template details in the body.
- [Remove shift template](https://www.bessy.academy/reference/post_shift-template-remove.md): Removes a shift template. A shift template record can only be removed if it has no associated base shifts. If base shifts are linked, the request will fail with reason existing-base-shifts.
- [Get base shift](https://www.bessy.academy/reference/get_base-shift-get.md): This endpoint can be used to retrieve a shift template. In the request you provide a session ID in the header and a shift template ID in the query.
- [List base shifts](https://www.bessy.academy/reference/get_base-shift-list.md): This endpoint can be used to list base shifts. At least one selector must be provided: _id, startDate+endDate, templateIds, userIds, taskTypeIds, or tagIds. When startDate/endDate are provided, they define a time window and must be provided together
- [Create base shift](https://www.bessy.academy/reference/post_base-shift-create.md): This endpoint can be used to create a base shift. In the request you provide a session ID in the header and base shift details in the body.
- [Update base shift](https://www.bessy.academy/reference/post_base-shift-update.md): This endpoint can be used to update a base shift. In the request you provide a session ID in the header and base shift details in the body.
- [Remove base shift](https://www.bessy.academy/reference/post_base-shift-remove.md): Removes a base shift.
- [Add base shift date exception](https://www.bessy.academy/reference/post_base-shift-add-date-exception.md): Add a date exception to a base shift. Returns the updated base shift.
- [Remove base shift date exception](https://www.bessy.academy/reference/post_base-shift-remove-date-exception.md): Remove a date exception from a base shift. Returns the updated base shift.
- [List shifts](https://www.bessy.academy/reference/get_shift-list.md): This endpoint returns generated shifts (recurring instances of base shifts) within a requested date range. The maximum allowed date range is 31 days. In the request you provide a session ID in the header, a required startDate and endDate in the query, and optional filters.
- [API key](https://www.bessy.academy/reference/api-key.md)
- [Logging calls to developers portal](https://www.bessy.academy/reference/logging-to-portal.md)
- [Webhook Signature](https://www.bessy.academy/reference/webhook-signature.md): Bessy uses a **signature hash** to ensure the integrity and authenticity of the webhook payloads it sends. This hash allows you, as a developer, to verify that the data has not been altered and is indeed sent by Bessy.   This documentation explains how to implement the verification process for Bessy webhooks in your application.
- [How to Webhook test](https://www.bessy.academy/reference/how-to-webhook-test.md)
- [Shifts API guide](https://www.bessy.academy/reference/shifts-api-guide.md)
- [Send emails via the API](https://www.bessy.academy/reference/send-emails-via-the-api.md)

## Pages
- [Pagina niet gevonden](https://www.bessy.academy/page/pagina-niet-gevonden.md)

## Changelog
- [API uitbreidingen en snel naar het juiste shiftbord](https://www.bessy.academy/changelog/api-uitbreidingen-en-snel-naar-het-juiste-shiftbord.md)
- [Verbeteringen in gebruikersbeheer, de public API en Outlook](https://www.bessy.academy/changelog/verbeteringen-in-gebruikersbeheer-de-public-api-en-outlook.md)
- [Zelf je export samenstellen en mailen via de API](https://www.bessy.academy/changelog/v12627.md)
- [Meer controle over shifts en extra inzicht op het planbord](https://www.bessy.academy/changelog/meer-controle-over-shifts-en-extra-inzicht-op-het-planbord.md)
- [Shifts, automations en Bessy Connect](https://www.bessy.academy/changelog/️-shifts-automations-en-bessy-connect.md)
- [Nieuwe sorteermogelijkheden, automation trigger en API uitbreiding](https://www.bessy.academy/changelog/nieuwe-sorteermogelijkheden-automation-trigger-en-api-uitbreiding.md)
- [Plannen in shifts](https://www.bessy.academy/changelog/coming-soon-plannen-in-shifts.md)
- [Verwachte reistijd delen en data van een ingevulde checklist ophalen](https://www.bessy.academy/changelog/verwachte-reistijd-delen-en-data-van-een-ingevulde-checklist-ophalen.md)
- [Sortering op het planbord en nieuwe endpoints](https://www.bessy.academy/changelog/️-sortering-op-het-planbord-en-nieuwe-endpoints.md)
- [List task API rate limits en Planbot instellingen per dag](https://www.bessy.academy/changelog/afwijkende-reistijden-en-uitbreidingen-in-de-api.md)