Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Time Off

Show Time Off

Shows a single Time Off record

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)View timeoffs (timeoff:read)Manage timeoffs (timeoff:write)
get/v1/timeoff/{id}

Path parameters

idstring required

Timeoff ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "timeoff": {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  }
}