---
title: "List Leave Policies Summary"
method: GET
path: "/v1/leave-policies/summary/{employment_id}"
tags: ["Leave Policies"]
---

# List Leave Policies Summary

`GET /v1/leave-policies/summary/{employment_id}`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/leave-policies/summary/{employment_id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `timeoff:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `timeoff:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

List 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 by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) |
| Company-scoped access token (assertion) | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) |
| Customer API token | Manage timeoffs (`time_and_attendance`) | View timeoffs (`timeoff:read`) | Manage timeoffs (`timeoff:write`) |

## Path parameters

- `employment_id` string, required

## Response `200`

Success

- ListLeavePoliciesSummaryResponse: Response schema for listing leave policies summary
  - `data` LeavePolicySummary[], required
    - `annual_balance` union, required: The annual balance represents the balance for the current entitlement period. Unlike the regular balance, it does not account for accrued value and only considers the annual entitlement as the basis for calculations.
      - UnlimitedDaysandHoursResponse
        - `type` 'unlimited', required
      - LimitedDaysandHoursResponse
        - `days` integer, required
        - `hours` integer, required
        - `type` 'limited', required
    - `annual_entitlement` union, required: The annual entitlement represents what an employee is entitled to in the current entitlement period. It does not account for any accrued value.
      - UnlimitedDaysandHoursResponse
        - `type` 'unlimited', required
      - LimitedDaysandHoursResponse
        - `days` integer, required
        - `hours` integer, required
        - `type` 'limited', required
    - `balance` union, required: The balance is the entitlement minus the taken timeoff (i.e 10 entitlement - 3 taken = 7 balance)
      - UnlimitedDaysandHoursResponse
        - `type` 'unlimited', required
      - LimitedDaysandHoursResponse
        - `days` integer, required
        - `hours` integer, required
        - `type` 'limited', required
    - `booked` object, required: Includes all upcoming requested time off.
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `current_entitlement` union, required: The current entitlement is the accrued time entitled for the employee plus any other extra entitlements (such as carryover).
      - UnlimitedDaysandHoursResponse
        - `type` 'unlimited', required
      - LimitedDaysandHoursResponse
        - `days` integer, required
        - `hours` integer, required
        - `type` 'limited', required
    - `leave_policy` EmployeeLeavePolicy, required: Leave Policy abstraction representation for the employee
      - `description` string, nullable, required
      - `leave_policy_variant_id` union, required: The ID of the leave policy variant
        - string, uuid
        - 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita' | 'civic_duty' | 'adoption' | 'caregiver' | 'transfer' | 'exam' | 'monkhood' | 'marriage' | 'sterilization' | 'celebration' | 'blood_donation' | 'health_day' | 'special' | 'career' | 'study' | 'voluntary' | 'adv' | 'public_duties' | 'force_majeure' | 'medical_visits' | 'marriage_child' | 'breastfeeding' | 'maternity_paid' | 'maternity_unpaid' | 'paternity_paid' | 'paternity_unpaid' | 'pregnancy_leave' | 'business_trip_eu' | 'business_trip_non_eu' | 'training' | 'sustainable_employability': The type of leave a time off record or leave policy represents. Responses may return any of these values. The set is a superset of the values accepted when creating a time off record (see `TimeoffType`): employments on the newer leave-type model can hold leave types that are not bookable by name.
      - `leave_type` 'time_off' | 'sick_leave' | 'public_holiday' | 'unpaid_leave' | 'extended_leave' | 'in_lieu_time' | 'maternity_leave' | 'paternity_leave' | 'parental_leave' | 'bereavement' | 'military_leave' | 'other' | 'paid_time_off' | 'custom_company_leave' | 'rtt' | 'casual_leave' | 'rol' | 'ex_festivita' | 'civic_duty' | 'adoption' | 'caregiver' | 'transfer' | 'exam' | 'monkhood' | 'marriage' | 'sterilization' | 'celebration' | 'blood_donation' | 'health_day' | 'special' | 'career' | 'study' | 'voluntary' | 'adv' | 'public_duties' | 'force_majeure' | 'medical_visits' | 'marriage_child' | 'breastfeeding' | 'maternity_paid' | 'maternity_unpaid' | 'paternity_paid' | 'paternity_unpaid' | 'pregnancy_leave' | 'business_trip_eu' | 'business_trip_non_eu' | 'training' | 'sustainable_employability', required: The type of leave a time off record or leave policy represents. Responses may return any of these values. The set is a superset of the values accepted when creating a time off record (see `TimeoffType`): employments on the newer leave-type model can hold leave types that are not bookable by name.
      - `name` string, required
      - `unit` 'days' | 'hours' | 'unlimited', required
    - `pending_approval` object, required: Includes requested timeoffs (not approved) in the past or in the future.
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `taken` object, required: Includes all time off (past and future, pending or approved).
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `upcoming_approved` object, required: Includes all upcoming approved time off.
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `upcoming_requested` object, required: Includes all upcoming requested time off.
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `used` object, required: Includes only approved time off in the past.
      - `days` integer, required
      - `hours` integer, required
      - `type` 'limited', required
    - `working_hours_per_day` integer, required

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/time-attendance.md) - [All operations](https://skmtc.dev/remote-com/apis/time-attendance/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/time-attendance/revisions/84de0ccef126?raw)