Time & Attendance
Leave Policies

List Leave Policies Details

Changed on

Describe the leave policies (custom or not) 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/details/{employment_id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/leave-policies/details/{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": [
    {
      "custom": true,
      "leave_policy_variant_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Self-Care",
      "uses_accrual_as_balance": false
    }
  ]
}

Changes

    • 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