Remote Time & Attendance API
The Time & Attendance API from Remote — 21 operation(s) for time & attendance.
Remote Time & Attendance 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 & Attendance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 26 operations across 21 paths, and defines 72 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/.
26 operations
21 paths
72 schemas
11 GET2 PATCH11 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 7
Remote Time & Attendance 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 26
Across 21 paths, the API surfaces 26 operations — 11 GET, 2 PATCH, 11 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Time & Attendance 26
GET
/v1/timesheets/{id}
Show timesheet
POST
/v1/timeoff/{timeoff_id}/cancel
Cancel Time Off
PATCH
/v1/employee/timeoff/{id}
Update Time Off as Employee
PUT
/v1/employee/timeoff/{id}
Update Time Off as Employee
POST
/v1/contractors/employments/{employment_id}/timesheets
Create a contractor timesheet
GET
/v1/employee/leave-policies
List Employee Leave Policies
GET
/v1/employee/leave-policies/summary
List Employee Leave Policies Summary
GET
/v1/timeoff-balances/{employment_id}deprecated
Show Time Off Balance
POST
/v1/employee/timeoff/{id}/cancel
Cancel Time Off as Employee
POST
/v1/timesheets/{timesheet_id}/approve
Approve timesheet
GET
/v1/leave-policies/summary/{employment_id}
List Leave Policies Summary
POST
/v1/timeoff/{timeoff_id}/cancel-request/decline
Decline a time off cancellation request
GET
/v1/timesheets
List timesheets
GET
/v1/leave-policies/details/{employment_id}
List Leave Policies Details
GET
/v1/timeoff/types
List Time Off Types
GET
/v1/timeoff/{id}
Show Time Off
PATCH
/v1/timeoff/{id}
Update Time Off
PUT
/v1/timeoff/{id}
Update Time Off
POST
/v1/timeoff/{timeoff_id}/decline
Decline Time Off
POST
/v1/timeoff/{timeoff_id}/approve
Approve Time Off
GET
/v1/employee/timeoff
List employee time offs
POST
/v1/employee/timeoff
Create a Pending Time Off
GET
/v1/timeoff
List Time Off
POST
/v1/timeoff
Create Time Off
POST
/v1/timesheets/{timesheet_id}/send-back
Send back a timesheet for review or modification
POST
/v1/timeoff/{timeoff_id}/cancel-request/approve
Approve a time off cancellation request
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are Timesheet (20 properties), Timeoff (18 properties), TimeTracking (13 properties), ContractorTimesheet (12 properties). Each schema is shown below with its type and property counts.
CreateApprovedTimeoffParams
object
Approved timeoff creation params
ParameterError
object
3 properties
3 required
MinimalTimesheet
object
A lightweight timesheet representation returned after create and approve operations. Contains basic identification and status fields but not the detailed hours…
9 properties
9 required
ResourceErrorResponse
object
Returned when an operation fails due to a resource-level conflict or constraint. Includes a structured error with a machine-readable code, a human-readable mes…
1 property
1 required
TimeoffResponse
object
Timeoff response
1 property
1 required
TimeTracking
object
A single time tracking entry within a timesheet, representing a block of work with clock-in/out times. Includes detailed breakdowns of hours by type (regular,…
13 properties
13 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
ContractorTimesheetResponse
object
Response returned after creating a contractor timesheet.
1 property
TimeoffBalanceNotSupportedResponse
object
TimeBreakdown
object
Detailed hours breakdown for a time tracking entry, split by time of day (day vs night) and then by type of day (regular, weekend, holiday). Useful for calcula…
2 properties
2 required
UpdateEmployeeTimeoffParams
object
Update timeoff params
8 properties
1 required
CancelTimeoffParams
object
Cancel timeoff params
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
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
LimitedDaysandHoursResponse
object
Includes requested timeoffs (not approved) in the past or in the future.
3 properties
3 required
ApproveTimeoffParams
object
Approve timeoff params
1 property
1 required
Timesheet
object
A timesheet represents an employee's recorded working hours for a specific date range. It contains aggregated hour totals and individual time tracking entries.…
20 properties
19 required
TimeoffDocumentParams
object
Timeoff document params
2 properties
2 required
TimeoffType
string
SentBackTimesheet
object
A timesheet that has been sent back to the employee for revision. The status will be incalibration and includes the reason provided by the reviewer.
4 properties
4 required
Timezone
string
[TZ identifier](https://www.iana.org/time-zones)
TypeOfDayBreakdown
object
Hours breakdown by type of day (regular working day, weekend, or public holiday) for a specific time of day (day or night).
3 properties
3 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…
ListTimesheetsResponse
object
Response schema listing many timesheets
1 property
ListLeavePoliciesSummaryResponse
object
Response schema for listing leave policies summary
1 property
1 required
UnprocessableEntityResponse
object
ContractorCreateTimesheetParams
object
Parameters for creating a timesheet on behalf of a contractor employment. The target employment is taken from the URL path, not the request body. Allowed timet…
3 properties
3 required
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
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
TimeoffBalanceResponse
object
Time Off Balance response
1 property
1 required
SendBackTimesheetParams
object
Parameters for sending a submitted timesheet back to the employee for revision. The timesheet status will change to incalibration and the employee will be noti…
1 property
1 required
ContractorTimesheet
object
A contractor timesheet, returned by the contractor create endpoint. Only contains fields relevant to the contractor flow — EOR-only fields (overtime, night/wee…
12 properties
12 required
ActionError
object
3 properties
3 required
ContractorTimesheetOverlapResponse
object
Returned when the submitted dates overlap an existing timesheet for the employment (HTTP 422). In addition to the standard errors/message fields, the response…
3 properties
3 required
HoursAndMinutes
object
A duration expressed as hours and minutes.
2 properties
ListLeavePoliciesDetailsResponse
object
Response schema for listing leave policies details
1 property
1 required
TimeoffTypeResponse
object
A single time off type with name and description
2 properties
1 required
ContractorCreateTimesheetUnprocessableEntityResponse
A validation error (HTTP 422). Either a standard error response, or — when the submitted dates overlap an existing timesheet — a response that additionally inc…
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
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property
1 required
TimesheetResponse
object
Response containing a full timesheet with all hour breakdowns and time tracking entries.
1 property
CreateTimeoffParams
object
Timeoff creation params
9 properties
5 required
TimesheetStatus
string
The current status of a timesheet in its lifecycle. - open: The timesheet is a draft and only visible to the employee. It has not been submitted yet. - submitt…
ListTimeoffResponse
object
Response schema listing many timeoffs
1 property
File
object
A file associated with an employment, such as a contract, tax form, or identity document.
5 properties
4 required
TimeoffBalanceNotFoundResponse
object
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…
ContractorTimeTrackingParams
object
Parameters for a single time tracking entry on a contractor timesheet. Allowed type values are restricted to the contractor subset.
5 properties
4 required
UuidSlug
string
Identifier of the employment being terminated.
CreateEmployeeTimeoffParams
object
Employee timeoff creation params
7 properties
5 required
TimeoffDaysAndHours
object
2 properties
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
SentBackTimesheetResponse
object
Response returned after a timesheet has been sent back to the employee for revision.
1 property
TimeoffBalance
object
8 properties
6 required
NullableDateTime
string
Optional UTC date time in YYYY-MM-DDTHH:mm:ss format
ContractorTimeTracking
object
A single time tracking entry on a contractor timesheet.
6 properties
6 required
UnlimitedDaysandHoursResponse
object
1 property
1 required
LeavePolicySummary
object
Leave Policy Summary
12 properties
12 required
ListTimeoffTypesResponse
object
Time off types response
1 property
CountryCode
string
Country code according to ISO 3166-1 3-digit alphabetic codes.
EmployeeLeavePolicy
object
Leave Policy abstraction representation for the employee
4 properties
4 required
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
MinimalTimesheetResponse
object
Response containing a minimal timesheet representation, returned after create and approve operations.
1 property
LeavePolicyDetails
object
Leave Policy Details
4 properties
3 required
TimeoffEntitlement
object
Detailed breakdown of an employment's time off balance.
7 properties
7 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Remote 12
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
#Time & Attendance