Time Off Balances

Show Time Off Balance

Shows the time off balance for the given employment_id.

Deprecated since February 2025 in favour of List Leave Policies Summary endpoint.

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.
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.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See 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)

get/v1/timeoff-balances/{employment_id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/timeoff-balances/{employment_id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.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
- or 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 HTTP bearer

Path parameters

employment_idstring required

Employment ID for which to show the time off balance

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Example response

{
  "data": {
    "timeoff_balance": {
      "contractual_entitled": {
        "days": 25,
        "hours": 0
      },
      "leave_entitlements": [
        {
          "entitled": {
            "days": 28,
            "hours": 0
          },
          "expiry_date": "2022-12-31",
          "name": "Annual paid time off",
          "remaining": {
            "days": 25,
            "hours": 0
          },
          "taken": {
            "days": 3,
            "hours": 0
          },
          "type": "annual_paid_timeoff"
        },
        {
          "entitled": {
            "days": 3,
            "hours": 0
          },
          "expiry_date": "2022-12-31",
          "name": "Extra days for good performance",
          "remaining": {
            "days": 3,
            "hours": 0
          },
          "taken": {
            "days": 0,
            "hours": 0
          },
          "type": "additional_pto"
        }
      ],
      "taken": {
        "days": 3,
        "hours": 0
      },
      "total_entitled_days": 31,
      "working_hours_per_day": 8
    }
  }
}

Changes

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