Time & Attendance
Leave Policies

List Leave Policies Summary

Changed on

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 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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)View timeoffs (timeoff:read)Manage timeoffs (timeoff:write)
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: 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_idstring required

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 adoption enum value to the /// response property for the response status

    • warning

      added the new adv enum value to the /// response property for the response status

    • warning

      added the new blood_donation enum value to the /// response property for the response status

    • warning

      added the new breastfeeding enum value to the /// response property for the response status

    • warning

      added the new business_trip_eu enum value to the /// response property for the response status

    • warning

      added the new business_trip_non_eu enum value to the /// response property for the response status

    • warning

      added the new career enum value to the /// response property for the response status

    • warning

      added the new caregiver enum value to the /// response property for the response status

    • warning

      added the new celebration enum value to the /// response property for the response status

    • warning

      added the new civic_duty enum value to the /// response property for the response status

    • warning

      added the new exam enum value to the /// response property for the response status

    • warning

      added the new force_majeure enum value to the /// response property for the response status

    • warning

      added the new health_day enum value to the /// response property for the response status

    • warning

      added the new marriage enum value to the /// response property for the response status

    • warning

      added the new marriage_child enum value to the /// response property for the response status

    • warning

      added the new maternity_paid enum value to the /// response property for the response status

    • warning

      added the new maternity_unpaid enum value to the /// response property for the response status

    • warning

      added the new medical_visits enum value to the /// response property for the response status

    • warning

      added the new monkhood enum value to the /// response property for the response status

    • warning

      added the new paternity_paid enum value to the /// response property for the response status

    • warning

      added the new paternity_unpaid enum value to the /// response property for the response status

    • warning

      added the new pregnancy_leave enum value to the /// response property for the response status

    • warning

      added the new public_duties enum value to the /// response property for the response status

    • warning

      added the new special enum value to the /// response property for the response status

    • warning

      added the new sterilization enum value to the /// response property for the response status

    • warning

      added the new study enum value to the /// response property for the response status

    • warning

      added the new sustainable_employability enum value to the /// response property for the response status

    • warning

      added the new training enum value to the /// response property for the response status

    • warning

      added the new transfer enum value to the /// response property for the response status

    • warning

      added the new voluntary enum value to the /// response property for the response status

    • info

      added subschema #2: ResponseTimeoffType to the /// response property anyOf list for the response status

    • info

      removed subschema #2: TimeoffType from the /// response property anyOf list for the response status

    • info

      added the required property /// to the response with the status