Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Out of Office

Search Out of Office

Endpoint to search out_of_office using filtering parameters.

get/business/v2/employees/out-of-office

Query parameters

delegatorIdstring[]

The ID of the person assigning the out_of_office.

[
  "7bf79328-a7ae-4222-aa54-091ff7f429a7"
]
delegateIdstring[]

The ID of the person covering for the delegator.

[
  "33333333-a7ae-4222-aa54-091ff7f429a7"
]
fromDatestring

Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:yyyy-MM-dd).

Example:2025-03-05

Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:yyyy-MM-dd).

toDatestring

Defines when the out_of_office entry ends, toDate included. (i.e. less than) (Format:yyyy-MM-ddThh:mm:ssZ,represents a UTC timezone).

Example:2025-03-07

Defines when the out_of_office entry ends, toDate included. (i.e. less than) (Format:yyyy-MM-ddThh:mm:ssZ,represents a UTC timezone).

statusDelegationStatus[]

The status of out_of_office.

The status of out_of_office.

featureDelegationFeature[]

The features of out_of_office.

The features of out_of_office.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing out_of_office.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "delegator_id": "XMPL1234-000001",
      "delegate_id": "XMPL1234-000002",
      "from_date": "2025-03-05",
      "to_date": "2025-03-07"
    }
  ]
}