Time Off

List Time Off Types

Lists all time off types that can be used for the timeoff_type parameter.

Backward compatibility: Calling this endpoint without the type query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change.

Optionally, pass type=contractor to get time off types for contractor employments, or type=full_time for full-time employments (same as omitting the parameter).

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

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/timeoff/types
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

Query parameters

type'contractor' | 'full_time'

Optional query parameter for the List Time Off Types endpoint.

contractor — time off types for contractor employments (e.g. includes time_off).
full_time — time off types for full-time employments (e.g. includes paid_time_off). When omitted, the response is unchanged from previous API versions (full-time types).

Example:full_time

Optional. Employment type to list time off types for: contractor or full_time. Omit for backward-compatible behavior (full-time types).

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_types": [
      {
        "description": "Sick leave",
        "name": "sick_leave"
      },
      {
        "description": "Yearly paid vacation days granted to employees.",
        "name": "paid_time_off"
      }
    ]
  }
}

Changes

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