Get Blocked Appointments

Description

Retrieves all active blocks applied to staff members, areas, or resources within the specified date range.
The returned blocks describe the affected period, time, blocked items, and additional details of the block.

🛂 The permission in EVO that grants access to this endpoint is Activity - Query.

🔑 Query Parameters

Parameter	Type	Required	Description
startDate	date-time	Yes	Start date for searching blocks.
endDate	date-time	Yes	End date for searching blocks.

📤 Response Structure

The response is a list containing the active blocks within the requested period.

Field	Type	Description
`name`	string	Name of the created block.
`startDate`	string	Start date of the block.
`endDate`	string	End date of the block.
`startTime`	string	Start time of the block (HH:MM).
`endTime`	string	End time of the block (HH:MM).
`description`	string	Detailed description of the block.
`totalBlocking`	boolean	Indicates whether the block is total (`true`) or partial (`false`).
`items`	object	Structure containing the items impacted by the block (detailed below).

🧩 Structure of `items`

Groups all elements that were impacted by the block.

`blockedEmployees` — Blocked Staff Members

Field	Type	Description
`idEmployee`	integer	Identifier of the blocked staff member.
`nameEmployee`	string	Name of the blocked staff member.

`blockedAreas` — Blocked Areas

Field	Type	Description
`idArea`	integer	Identifier of the blocked area.
`nameArea`	string	Name of the blocked area.

`blockedResources` — Blocked Resources

Field	Type	Description
`nameResource`	string	Name of the blocked resource.
`quantityResource`	integer	Blocked quantity of the resource.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "name": "string",
        "startDate": "string",
        "endDate": "string",
        "startTime": "string",
        "endTime": "string",
        "description": "string",
        "totalBlocking": true,
        "items": {
            "blockedEmployees": [
                {
                    "idEmployee": 0,
                    "nameEmployee": "string"
                }
            ],
            "blockedAreas": [
                {
                    "idArea": 0,
                    "nameArea": "string"
                }
            ],
            "blockedResources": [
                {
                    "nameResource": "string",
                    "quantityResource": 0
                }
            ]
        }
    }
]

🟠400Bad Request

Get blocked appointments

Get Blocked Appointments#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of items#

blockedEmployees — Blocked Staff Members#

blockedAreas — Blocked Areas#

blockedResources — Blocked Resources#

Request