Out of Office

Get Out of Office

Endpoint to get a specific out_of_office by ID.

get/business/v2/employees/out-of-office/{out_of_office_id}

Request

  • Base URL
    https://api.soldo.com
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://api.soldo.com/oauth/authorize
    Scopesout_of_office_delegation_read

Path parameters

out_of_office_idstring required

The out-of-office ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7

Response

The result is a single out_of_office.

idstring

A unique identifier for this out_of_office entry.

delegator_idstring

The ID of the person assigning the out_of_office.

delegate_idstring

The ID of the person covering for the delegator.

from_datestring date

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

to_datestring date

Defines when the out_of_office entry ends. toDate included. (i.e. less than) (Format:yyyy-MM-dd).

featuresDelegationFeature[]

The features of out_of_office.

status'ACTIVE' | 'EXPIRED' | 'SCHEDULED' | 'DELETED'

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "delegator_id": "XMPL1234-000001",
  "delegate_id": "XMPL1234-000002",
  "from_date": "2025-03-05",
  "to_date": "2025-03-07"
}

Changes

No recorded changes to this operation across all 10 revisions of this API.