Time Off

List Time Off

Lists all Time Off records.

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

Request

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

employment_idstring

Only show time off for a specific employment

The type of leave a time off record or leave policy represents.

Responses may return any of these values. The set is a superset of the values accepted when creating a time off record (see TimeoffType): employments on the newer leave-type model can hold leave types that are not bookable by name.

Example:sick_leave

Filter time off by its type. Accepts every value a time off record may carry.

The current status of a time off request.

requested: The employee has submitted a time off request and it is awaiting approval.
approved: The time off request has been approved by a manager.
cancelled: The time off request was cancelled by the employee or an admin.
declined: The time off request was declined by a manager.
taken: The approved time off has been taken (the dates have passed).
cancel_requested: The employee has requested cancellation of a previously approved time off, pending manager approval.

Example:requested

Filter time off by its status

start_datestring date

UTC date in ISO 8601 format

Example:2021-07-01

ISO 8601 date. When combined with end_date, returns all time off records that overlap the [start_date, end_date] window — including records that only partially overlap at either boundary. When used alone, returns records whose start_date is on or after this date.

end_datestring date

UTC date in ISO 8601 format

Example:2021-07-01

ISO 8601 date. When combined with start_date, returns all time off records that overlap the [start_date, end_date] window — including records that only partially overlap at either boundary. When used alone, returns records whose end_date is on or before this date.

order'asc' | 'desc'

Sort order

sort_by'timeoff_type' | 'status'

Field to sort by

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

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

{
  "current_page": 1,
  "timeoffs": [
    {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

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