Remote Time Off API

The Time Off API from Remote — 8 operation(s) for time off.

Documentation Provider Profile APIs.io OpenAPI GitHub

Remote Time Off API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Time Off. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 8 paths, and defines 33 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

11 operations 8 paths 33 schemas 3 GET1 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

0.1.0

Base URL

https://gateway.remote.com/v1/

Authentication

HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0

Resource Areas

Authentication & Security 7

Remote Time Off API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
OAuth2 — Authenticate using OAuth 2.0 protocol.
OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 3 GET, 1 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Time Off 11

POST

/v1/timeoff/{timeoff_id}/cancel

Cancel Time Off

post_v1_timeoff_timeoff_id_cancel 1 param body → 200400401404422429

POST

/v1/timeoff/{timeoff_id}/cancel-request/decline

Decline a time off cancellation request

post_v1_timeoff_timeoff_id_cancel-request_decline 1 param body → 200401409422429

GET

/v1/timeoff/types

List Time Off Types

get_v1_timeoff_types 2 params → 200400401404422429

GET

/v1/timeoff/{id}

Show Time Off

get_v1_timeoff_id 2 params → 200400401404422429

PATCH

/v1/timeoff/{id}

Update Time Off

patch_v1_timeoff_id (2) 2 params body → 200400401404422429

PUT

/v1/timeoff/{id}

Update Time Off

patch_v1_timeoff_id 2 params body → 200400401404422429

POST

/v1/timeoff/{timeoff_id}/decline

Decline Time Off

post_v1_timeoff_timeoff_id_decline 1 param body → 200400401404422429

POST

/v1/timeoff/{timeoff_id}/approve

Approve Time Off

post_v1_timeoff_timeoff_id_approve 1 param body → 200400401404422429

GET

/v1/timeoff

List Time Off

get_v1_timeoff 10 params → 200400401404422429

POST

/v1/timeoff

Create Time Off

post_v1_timeoff 1 param body → 201400401404422429

POST

/v1/timeoff/{timeoff_id}/cancel-request/approve

Approve a time off cancellation request

post_v1_timeoff_timeoff_id_cancel-request_approve 1 param → 200401422429

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Timeoff (18 properties), UpdateApprovedTimeoffParams (12 properties), CreateTimeoffParams (9 properties), File (5 properties). Each schema is shown below with its type and property counts.

CreateApprovedTimeoffParams

object

Approved timeoff creation params

ParameterError

object

3 properties 3 required

TimeoffResponse

object

Timeoff response

1 property 1 required

Date

string

UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format

CancelTimeoffParams

object

Cancel timeoff params

1 property 1 required

SuccessResponse

object

A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).

1 property 1 required

ConflictResponse

object

Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…

1 property

ApproveTimeoffParams

object

Approve timeoff params

1 property 1 required

TimeoffDocumentParams

object

Timeoff document params

2 properties 2 required

TimeoffType

string

Timezone

string

[TZ identifier](https://www.iana.org/time-zones)

UnauthorizedResponse

object

Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…

1 property 1 required

TimeoffStatus

string

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 requ…

UnprocessableEntityResponse

object

TimeoffDaysParams

object

Timeoff days params

2 properties

BadRequestResponse

object

Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…

LeavePolicy

object

The leave policy associated with a time off request. Policies define the rules and entitlements for specific types of leave.

3 properties 3 required

ActionError

object

3 properties 3 required

TimeoffTypeResponse

object

A single time off type with name and description

2 properties 1 required

DeclineTimeoffParams

object

1 property 1 required

NotFoundResponse

object

Returned when the requested resource does not exist or is not accessible with the current authentication credentials.

1 property

CreateTimeoffParams

object

Timeoff creation params

9 properties 5 required

File

object

A file associated with an employment, such as a contract, tax form, or identity document.

5 properties 4 required

ListTimeoffResponse

object

Response schema listing many timeoffs

1 property

NullableApproverId

string

The field matches the id of a user in the Remote Platform that has permission to approve time off requests. [Available users][] can be found fetching the [List…

UpdateApprovedTimeoffParams

object

Update timeoff params

12 properties 2 required

TimeoffDay

object

A single day within a time off request, specifying the date and the number of hours taken off that day.

3 properties 3 required

DateTimeIso8601

string

UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601

Timeoff

object

A time off record for an employee, representing a period of leave (e.g., vacation, sick leave, parental leave).

18 properties 10 required

NullableDateTime

string

Optional UTC date time in YYYY-MM-DDTHH:mm:ss format

ListTimeoffTypesResponse

object

Time off types response

1 property

TimeoffTypesEmploymentType

string

Optional query parameter for the List Time Off Types endpoint. - contractor — time off types for contractor employments (e.g. includes timeoff). - fulltime — t…

TooManyRequestsResponse

object

Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.

1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Remote publishes across the network.

Remote Address Details API

AE Profile APIs.io

Remote Administrative Details API

AE Profile APIs.io

Remote Background Checks API

AE Profile APIs.io

Remote Bank Account Details API

AE Profile APIs.io

Remote Basic Information API

AE Profile APIs.io

Remote Benefit Offers API

AE Profile APIs.io

Remote Benefit Offers By Employment API

AE Profile APIs.io

Remote Benefit Renewals API

AE Profile APIs.io

Remote Benefits API

AE Profile APIs.io

Remote Billing Address Details API

AE Profile APIs.io

Remote Billing API

AE Profile APIs.io

Remote Billing Documents API

AE Profile APIs.io

#Time Off

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Remote Time Off API

Metadata

Authentication & Security 7

Paths & Operations 11

Schemas 33

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Remote Time Off API

Metadata

Authentication & Security 7

Paths & Operations 11

Schemas 33

Specification

Source

More from Remote 12

API Details

Provider

Explore more