ETO (Everyone time-off)

Use this endpoint to manage Everyone Time Off events in the workspace.

https://next.liquidplanner.com/api/workspaces/workspace id/time-off/eto/v1

Supported Methods

POST

Add a new Everyone Time Off (ETO) event to block scheduling for everyone in the workspace on the provided Start and End dates.

Example: The example below adds a new ETO event called “Company Holiday” scheduled on 15th March 2023.

curl --location --request POST 'https://next.liquidplanner.com/api/workspaces/<workspace id>/time-off/eto/v1' \
--header 'Authorization: Bearer <API Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Company Holiday",
    "startDate": "2023-03-15",
    "endDate": "2023-03-15"
}'

UPDATE

Send a PUT request to make changes to an existing ETO event.

Example: The example below can be used to rename an existing ETO event in the workspace.

curl --location --request PUT 'https://next.liquidplanner.com/api/workspaces/<workspace id>/time-off/eto/v1/<ETO id>' \
--header 'Authorization: Bearer <API Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Company Retreat Holiday"
}'

GET

Pull a list of all the ETO events from your workspace in a JSON format.

Sample Response

{
    "recordLimit": 500,
    "recordCount": 1,
    "data": [
        {
            "id": 2265,
            "startDate": "2023-03-15",
            "endDate": "2023-03-16",
            "description": "Company Retreat Holiday",
            "createdAt": "2022-10-10T20:11:46.582528Z",
            "updatedAt": "2022-10-10T20:11:46.582Z",
            "createdById": 197,
            "updatedById": 213,
            "workspaceId": 21,
            "organizationId": 21
        }

Filter Options

Apply the filter string to the endpoint URL.

Filter attribute	Field type	Description	Filter string
startDate	date	Pull a list of ETO events based on their start date	?startDate[after]="2023-12-31"
endDate	date	Pull a list of ETO events based on their end date	?endDate[before]="2024-01-01"