Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Employee Time Off API

The Employee Time Off API from Remote — 3 operation(s) for employee time off.

Remote Employee 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 Employee Time Off. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 24 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/.

5 operations 3 paths 24 schemas 1 GET1 PATCH2 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
1

Authentication & Security 7

Remote Employee 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 5

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

Employee Time Off 5
PATCH
/v1/employee/timeoff/{id}
Update Time Off as Employee
patch_v1_employee_timeoff_id (2) 1 param body → 200400401404422429
PUT
/v1/employee/timeoff/{id}
Update Time Off as Employee
patch_v1_employee_timeoff_id 1 param body → 200400401404422429
POST
/v1/employee/timeoff/{id}/cancel
Cancel Time Off as Employee
post_v1_employee_timeoff_id_cancel 1 param body → 200400401404422429
GET
/v1/employee/timeoff
List employee time offs
get_v1_employee_timeoff 2 params → 200400401404429
POST
/v1/employee/timeoff
Create a Pending Time Off
post_v1_employee_timeoff body → 201400401404422429

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Timeoff (18 properties), UpdateEmployeeTimeoffParams (8 properties), CreateEmployeeTimeoffParams (7 properties), File (5 properties). Each schema is shown below with its type and property counts.

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
UpdateEmployeeTimeoffParams
object
Update timeoff params
8 properties 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
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
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
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…
CreateEmployeeTimeoffParams
object
Employee timeoff creation params
7 properties 5 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
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

remote-employee-time-off-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API