Sign in
Orgs / Users / OOO

Get all out-of-office entries for organization users

get/v2/organizations/{orgId}/ooo

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdnumber required

Query parameters

takenumber
Example:25

Maximum number of items to return

skipnumber

Number of items to skip

sortStart'asc' | 'desc'
Example:?sortStart=asc OR ?sortStart=desc

Sort results by their start time in ascending or descending order.

sortEnd'asc' | 'desc'
Example:?sortEnd=asc OR ?sortEnd=desc

Sort results by their end time in ascending or descending order.

emailstring
Example:example@domain.com

Filter ooo entries by the user email address. user must be within your organization.

Headers

Authorizationstring

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-keystring

For platform customers - OAuth client secret key

x-cal-client-idstring

For platform customers - OAuth client ID

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": [
    {
      "userId": 2,
      "toUserId": 2,
      "id": 2,
      "start": "2023-05-01T00:00:00.000Z",
      "end": "2023-05-10T23:59:59.999Z",
      "notes": "Vacation in Hawaii",
      "reason": "vacation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.