API Reference

Create Time Off

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

Creates a Time Off record

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage timeoffs (time_and_attendance)-Manage timeoffs (timeoff:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Timeoff

Approved timeoff creation params

document
object

Timeoff document params

string
required
string
required
uuid

UUID of a leave policy assigned to the employment. Use this field instead of timeoff_type to book against a specific policy; for employments on the leave-type model it is the only way to target one. Discover the available UUIDs via GET /v1/leave-policies/details/{employment_id}.

string
string
required
timeoff_days
array of objects
required
timeoff_days*
string
enum

The type of leave accepted when creating or updating a time off record.

string
required

TZ identifier

date-time
required

UTC date time in ISO 8601 format.

string | null
required

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 Company Manager endpoint.

string
enum
required
Allowed:
Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?