List employee time offs
Changed onLists the current employee's time off records
Authentication
This endpoint requires the following token type:
- Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.
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/employee/timeoff
- Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/employment.manage, timeoff:read, timeoff:write, time_and_attendance, all:write, all:read)
Query parameters
Starts fetching records after the given page
Number of items per page
Response
Success
Example response
{
"current_page": 1,
"timeoffs": [
{
"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
}
],
"total_count": 1,
"total_pages": 1
}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