List Leave Policies Summary
Changed onList all the data related to time off for a given employment
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/leave-policies/summary/{employment_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
Employment ID
Response
Success
Example response
{
"data": [
{
"annual_balance": {
"days": 1,
"hours": 3,
"type": "limited"
},
"annual_entitlement": {
"days": 1,
"hours": 3,
"type": "limited"
},
"balance": {
"days": 1,
"hours": 3,
"type": "limited"
},
"booked": {
"days": 1,
"hours": 3,
"type": "limited"
},
"current_entitlement": {
"days": 1,
"hours": 3,
"type": "limited"
},
"leave_policy": {
"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque.",
"leave_policy_variant_id": "123e4567-e89b-12d3-a456-426614174000",
"leave_type": "sick_leave",
"name": "Self-Care",
"unit": "days"
},
"pending_approval": {
"days": 1,
"hours": 3,
"type": "limited"
},
"taken": {
"days": 1,
"hours": 3,
"type": "limited"
},
"upcoming_approved": {
"days": 1,
"hours": 3,
"type": "limited"
},
"upcoming_requested": {
"days": 1,
"hours": 3,
"type": "limited"
},
"used": {
"days": 1,
"hours": 3,
"type": "limited"
},
"working_hours_per_day": 8
}
]
}Changes
- 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
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
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
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
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
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
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
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_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
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_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
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
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
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
transferenum value to the///response property for the response status - warning
added the new
voluntaryenum value to the///response property for the response status - info
added
subschema #2: ResponseTimeoffTypeto the///response propertyanyOflist for the response status - info
removed
subschema #2: TimeoffTypefrom the///response propertyanyOflist for the response status
- warning
- info
added the required property
///to the response with the status
- info