Show Time Off
Changed onShows a single Time Off record
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage timeoffs (time_and_attendance) | View timeoffs (timeoff:read) | Manage timeoffs (timeoff:write) |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/timeoff/{id}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, timeoff:read, timeoff:write, time_and_attendance, all:write, all:read)
Path parameters
Timeoff ID
Headers
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
}
}
}Changes
- warning
added the new
adoptionenum value to the///response property for the response status - warning
added the new
adoptionenum value to the//response property for the response status - warning
added the new
advenum value to the///response property for the response status - warning
added the new
advenum value to the//response property for the response status - warning
added the new
blood_donationenum value to the///response property for the response status - warning
added the new
blood_donationenum value to the//response property for the response status - warning
added the new
breastfeedingenum value to the///response property for the response status - warning
added the new
breastfeedingenum value to the//response property for the response status - warning
added the new
business_trip_euenum value to the///response property for the response status - warning
added the new
business_trip_euenum value to the//response property for the response status - warning
added the new
business_trip_non_euenum value to the///response property for the response status - warning
added the new
business_trip_non_euenum value to the//response property for the response status - warning
added the new
careerenum value to the///response property for the response status - warning
added the new
careerenum value to the//response property for the response status - warning
added the new
caregiverenum value to the///response property for the response status - warning
added the new
caregiverenum value to the//response property for the response status - warning
added the new
celebrationenum value to the///response property for the response status - warning
added the new
celebrationenum value to the//response property for the response status - warning
added the new
civic_dutyenum value to the///response property for the response status - warning
added the new
civic_dutyenum value to the//response property for the response status - warning
added the new
examenum value to the///response property for the response status - warning
added the new
examenum value to the//response property for the response status - warning
added the new
force_majeureenum value to the///response property for the response status - warning
added the new
force_majeureenum value to the//response property for the response status - warning
added the new
health_dayenum value to the///response property for the response status - warning
added the new
health_dayenum value to the//response property for the response status - warning
added the new
marriageenum value to the///response property for the response status - warning
added the new
marriageenum value to the//response property for the response status - warning
added the new
marriage_childenum value to the///response property for the response status - warning
added the new
marriage_childenum value to the//response property for the response status - warning
added the new
maternity_paidenum value to the///response property for the response status - warning
added the new
maternity_paidenum value to the//response property for the response status - warning
added the new
maternity_unpaidenum value to the///response property for the response status - warning
added the new
maternity_unpaidenum value to the//response property for the response status - warning
added the new
medical_visitsenum value to the///response property for the response status - warning
added the new
medical_visitsenum value to the//response property for the response status - warning
added the new
monkhoodenum value to the///response property for the response status - warning
added the new
monkhoodenum value to the//response property for the response status - warning
added the new
paternity_paidenum value to the///response property for the response status - warning
added the new
paternity_paidenum value to the//response property for the response status - warning
added the new
paternity_unpaidenum value to the///response property for the response status - warning
added the new
paternity_unpaidenum value to the//response property for the response status - warning
added the new
pregnancy_leaveenum value to the///response property for the response status - warning
added the new
pregnancy_leaveenum value to the//response property for the response status - warning
added the new
public_dutiesenum value to the///response property for the response status - warning
added the new
public_dutiesenum value to the//response property for the response status - warning
added the new
specialenum value to the///response property for the response status - warning
added the new
specialenum value to the//response property for the response status - warning
added the new
sterilizationenum value to the///response property for the response status - warning
added the new
sterilizationenum value to the//response property for the response status - warning
added the new
studyenum value to the///response property for the response status - warning
added the new
studyenum value to the//response property for the response status - warning
added the new
sustainable_employabilityenum value to the///response property for the response status - warning
added the new
sustainable_employabilityenum value to the//response property for the response status - warning
added the new
trainingenum value to the///response property for the response status - warning
added the new
trainingenum value to the//response property for the response status - warning
added the new
transferenum value to the///response property for the response status - warning
added the new
transferenum value to the//response property for the response status - warning
added the new
voluntaryenum value to the///response property for the response status - warning
added the new
voluntaryenum value to the//response property for the response status
- warning
- info
added the required property
////to the response with the status - info
added the required property
//to the response with the status
- info