Remote Offboarding API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Offboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
17 operations
across 12 paths,
and defines 53 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/.
The identity and technical contract details declared by the specification.
Remote Offboarding 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.
ParameterError
object
3 properties
3 required
WorkAuthorizationRequestResponse
object
Schema for work authorization request
1 property
1 required
TerminationDetailsParams
object
16 properties
6 required
ApprovedWorkAuthozation
object
Schema for approved work authorization
2 properties
1 required
ResignationResponse
object
Resignation response
1 property
V2Offboarding
object
An offboarding record. Top-level fields hold the offboarding's lifecycle state. The nested request object holds the immutable creation snapshot of the inputs s…
9 properties
5 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
WorkAuthorizationUser
object
A user associated with a work authorization request (either the employee or the employer approver).
3 properties
3 required
Resignation
object
Resignation details for an offboarding request. The shape depends on whether the employee resigned before or after their employment start date.
1 property
ListWorkAuthorizationRequestsResponse
object
Response schema listing many workauthorizationrequests
1 property
ListOffboardingResponse
object
Response schema listing many offboardings
1 property
WorkAuthorizationRequest
object
A work authorization request submitted by an employee who needs authorization to work in a different country. Similar to a travel letter request but specifical…
14 properties
14 required
TerminationOffboarding
object
An offboarding request initiated by the employer to terminate an employment. Includes termination details, risk assessment, and status tracking through Remote'…
19 properties
14 required
DeclinedWorkAuthozation
object
Schema for declined work authorization
3 properties
2 required
ResignationAfterStartDate
object
Resignation details for an employee who resigned after their employment start date. Includes contract terms, notice period calculations, and PTO breakdown need…
10 properties
10 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
V2OffboardingResponse
object
Response containing a single v2 offboarding record.
1 property
V2TerminationRequest
object
Snapshot of the inputs submitted when a termination offboarding was created. These fields do not change as the offboarding progresses.
8 properties
OffboardingResponse
object
Response containing a single offboarding record with full details.
1 property
RequestError
object
1 property
1 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
DeclinedTravelLetter
object
Schema for declined travel letter
3 properties
2 required
ValidateResignationRequestParams
object
UnprocessableEntityResponse
object
ResignationBeforeStartDateRequestParams
object
2 properties
1 required
Country
object
A supported country on Remote
11 properties
3 required
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…
TravelLetterRequest
object
A travel letter request submitted by an employee who needs a formal letter from their employer to support a visa or travel application. The request goes throug…
20 properties
20 required
UpdateWorkAuthorizationRequestParams
Schema for updating a work authorization request
ActionError
object
3 properties
3 required
V2ListOffboardingResponse
object
Response schema listing many offboardings
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
ApprovedTravelLetter
object
Schema for approved travel letter
5 properties
4 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
GenericFile
string
A file represented as a base64-encoded string.
ResignationFile
object
2 properties
2 required
UuidSlug
string
Identifier of the employment being terminated.
ResignationOffboarding
object
An offboarding request initiated by the employee (a resignation). Includes the employee's proposed last working day, reason, and status tracking through Remote…
14 properties
9 required
OffboardingFile
object
2 properties
2 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties
1 required
V2ResignationRequest
object
Snapshot of the inputs submitted when a resignation offboarding was created. These fields do not change as the offboarding progresses.
4 properties
ResignationBeforeStartDate
object
Resignation details for an employee who resigned before their employment start date. Contains basic contract and resignation information only.
4 properties
4 required
V2OffboardingRequest
The shape depends on the originating request: offboardings that originated from a termination carry a V2TerminationRequest; those that originated from a resign…
ResignationOrTerminationOffboarding
object
DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
CreateOffboardingParams
object
3 properties
3 required
UpdateTravelLetterRequestParams
Schema for updating travel letter request parameters
ListTravelLettersResponse
object
Response schema listing many travelletterrequests
1 property
Offboarding
object
A wrapper containing an offboarding record, which can be either a termination (employer-initiated) or a resignation (employee-initiated).
1 property
ResignationAfterStartDateRequestParams
object
15 properties
7 required
TravelLetterResponse
object
Schema for travel letter request
1 property
1 required
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
TravelLetterUser
object
A user associated with a travel letter request (either the employee or the employer approver).
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
