---
title: "Search Out of Office"
method: GET
path: "/business/v2/employees/out-of-office"
tags: ["Out of Office"]
---

# Search Out of Office

`GET /business/v2/employees/out-of-office`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/employees/out-of-office`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `out_of_office_delegation_read`

Endpoint to search `out_of_office` using filtering parameters.

## Query parameters

- `delegatorId` string[]: The ID of the person assigning the `out_of_office`.
- `delegateId` string[]: The ID of the person covering for the delegator.
- `fromDate` string: Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:`yyyy-MM-dd`).
- `toDate` string: Defines when the out_of_office entry ends, toDate included. (i.e. less than) (Format:`yyyy-MM-ddThh:mm:ssZ`,represents a UTC timezone).
- `status` DelegationStatus[]: The status of `out_of_office`.
- `feature` DelegationFeature[]: The features of `out_of_office`.
- `p` integer: It indicates the specific page to display (the counter starts from zero).
- `s` integer: It indicates the number of items per page.
- `d` 'ASC' | 'DESC': It indicates how the pages are ordered.
- `props` string[]: 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.

## Response `200`

The result is an array containing `out_of_office`.

- OutOfOfficeDelegations
  - `total` integer: It represents the total number of available items in the list.
  - `pages` integer: It represents the total number of available pages.
  - `page_size` integer: It represents the number of items per page.
  - `current_page` integer: It indicates the current page (the counter starts from zero).
  - `results_size` integer: It indicates the size of the array results.
  - `results` OutOfOfficeDelegation[]
    - `id` string: A unique identifier for this `out_of_office` entry.
    - `delegator_id` string: The ID of the person assigning the `out_of_office`.
    - `delegate_id` string: The ID of the person covering for the delegator.
    - `from_date` string, date: Defines when the out_of_office entry starts. fromDate included. (i.e. greater than or equal to) (Format:`yyyy-MM-dd`).
    - `to_date` string, date: Defines when the out_of_office entry ends. toDate included. (i.e. less than) (Format:`yyyy-MM-dd`).
    - `features` DelegationFeature[]: The features of `out_of_office`.
    - `status` 'ACTIVE' | 'EXPIRED' | 'SCHEDULED' | 'DELETED'

## Other responses

- `400`: Your request has missing arguments or is malformed.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)