Leave Policies

List Employee Leave Policies Summary

List the leave policies summary (balances and entitlements) for the current employee

Authentication

This endpoint accepts any one of the following token types:

Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

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)
Employee-scoped access token	Manage timeoffs (time_and_attendance)	View timeoffs (timeoff:read)	Manage timeoffs (timeoff:write)
Company-scoped access token	Manage timeoffs (time_and_attendance)	View timeoffs (timeoff:read)	Manage timeoffs (timeoff:write)

get/v1/employee/leave-policies/summary

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/employee/leave-policies/summary
Auth
- OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: timeoff:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/employment.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: timeoff:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write

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

No recorded changes to this operation across all 1 revision of this API.