How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Remote

Remote Offboarding API

The Offboarding API from Remote — 12 operation(s) for offboarding.

Documentation Provider Profile APIs.io OpenAPI GitHub

Remote Offboarding API is one of 14 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.2.0, at version 0.1.0.

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

17 operations 12 paths 53 schemas 11 GET2 PATCH1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 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.

Paths & Operations 17

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

Offboarding 17
GET
/v1/offboardings
List Offboarding
get_v1_offboardings 5 params → 200400401404422429
POST
/v1/offboardings
Create Offboarding
post_v1_offboardings body → 201400401404422429500
GET
/v2/offboardings
List Offboardings (v2)
get_v2_offboardings 5 params → 200400401404422429
GET
/v2/offboardings/{id}
Show Offboarding (v2)
get_v2_offboardings_id 1 param → 200400401404422429
GET
/v1/work-authorization-requests/{id}
Show work authorization request
get_v1_work-authorization-requests_id 1 param → 200404422
PATCH
/v1/work-authorization-requests/{id}
Update work authorization request
patch_v1_work-authorization-requests_id (2) 1 param body → 200401404422
PUT
/v1/work-authorization-requests/{id}
Update work authorization request
patch_v1_work-authorization-requests_id 1 param body → 200401404422
GET
/v1/resignations/{offboarding_request_id}/resignation-letter
Download a resignation letter
get_v1_resignations_offboarding_request_id_resignation-letter 1 param → 200400401403404422429
GET
/v1/travel-letter-requests/{id}
Show travel letter request
get_v1_travel-letter-requests_id 1 param → 200401404422
PATCH
/v1/travel-letter-requests/{id}
Updates a travel letter request
patch_v1_travel-letter-requests_id (2) 1 param body → 200401404422
PUT
/v1/travel-letter-requests/{id}
Updates a travel letter request
patch_v1_travel-letter-requests_id 1 param body → 200401404422
GET
/v1/travel-letter-requests
List travel letter requests
get_v1_travel-letter-requests 7 params → 200404422
GET
/v1/offboardings/employments/{employment_id}
List Offboardings for Employment
get_v1_offboardings_employments_employment_id 3 params → 200400401404422429
GET
/v1/offboardings/{id}
Show Offboarding
get_v1_offboardings_id 1 param → 200400401404422429
GET
/v1/resignations/{offboarding_request_id}
Show Resignation
get_v1_resignations_offboarding_request_id 1 param → 200400401404422429
PUT
/v1/resignations/{offboarding_request_id}/validate
Validate resignation request
put_v1_resignations_offboarding_request_id_validate 1 param body → 200400401404422429
GET
/v1/work-authorization-requests
List work authorization requests
get_v1_work-authorization-requests 7 params → 200404422

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are TravelLetterRequest (20 properties), TerminationOffboarding (19 properties), TerminationDetailsParams (16 properties), ResignationAfterStartDateRequestParams (15 properties). Each schema is shown below with its type and property counts.

UpdateTravelLetterRequestParams
Schema for updating travel letter request parameters
TravelLetterUser
objectnull
A user associated with a travel letter request (either the employee or the employer approver).
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
WorkAuthorizationUser
objectnull
A user associated with a work authorization request (either the employee or the employer approver).
3 properties 3 required
V2TerminationRequest
object
Snapshot of the inputs submitted when a termination offboarding was created. These fields do not change as the offboarding progresses.
8 properties
V2ListOffboardingResponse
object
Response schema listing many offboardings
1 property
DeclinedWorkAuthozation
object
Schema for declined work authorization
3 properties 2 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
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
OffboardingResponse
object
Response containing a single offboarding record with full details.
1 property
TerminationDetailsParams
object
16 properties 6 required
ResignationBeforeStartDateRequestParams
object
2 properties 1 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
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ListOffboardingResponse
object
Response schema listing many offboardings
1 property
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties 1 required
V2OffboardingResponse
object
Response containing a single v2 offboarding record.
1 property
Country
object
A supported country on Remote
11 properties 3 required
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
DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
UuidSlug
string
Identifier of the employment being terminated.
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
ResignationResponse
object
Resignation response
1 property
ActionError
object
3 properties 3 required
ResignationFile
object
2 properties 2 required
ResignationAfterStartDateRequestParams
object
15 properties 7 required
WorkAuthorizationRequestResponse
object
Schema for work authorization request
1 property 1 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
Offboarding
object
A wrapper containing an offboarding record, which can be either a termination (employer-initiated) or a resignation (employee-initiated).
1 property
ValidateResignationRequestParams
object
RequestError
object
1 property 1 required
OffboardingFile
object
2 properties 2 required
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
ParameterError
object
3 properties 3 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
V2OffboardingRequest
The shape depends on the originating request: offboardings that originated from a termination carry a V2TerminationRequest; those that originated from a resign…
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
UpdateWorkAuthorizationRequestParams
Schema for updating a work authorization request
TravelLetterResponse
object
Schema for travel letter request
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
DeclinedTravelLetter
object
Schema for declined travel letter
3 properties 2 required
ListTravelLettersResponse
object
Response schema listing many travelletterrequests
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
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
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…
GenericFile
string
A file represented as a base64-encoded string.
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
CreateOffboardingParams
object
3 properties 3 required
ApprovedTravelLetter
object
Schema for approved travel letter
5 properties 4 required
ResignationOrTerminationOffboarding
object
ApprovedWorkAuthozation
object
Schema for approved work authorization
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-offboarding-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Benefits API
AE Profile APIs.io
Remote Billing API
AE Profile APIs.io
Remote Companies API
AE Profile APIs.io
Remote Contractors API
AE Profile APIs.io
Remote Contracts API
AE Profile APIs.io
Remote Employee Actions API
AE Profile APIs.io
Remote Employments API
AE Profile APIs.io
Remote Getting Started API
AE Profile APIs.io
Remote Integrations API
AE Profile APIs.io
Remote Partner Configuration API
AE Profile APIs.io
Remote Pay & Compensation API
AE Profile APIs.io
Remote Testing & Sandbox API
AE Profile APIs.io
#Offboarding
← Back to R APIs
API Details
ID
remote:remote-offboarding-api
Base URL
https://gateway.remote.com/v1/
Docs
https://developer.remote.com/reference/welcome-to-remote-api
Provider
Remote
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=remote-offboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/remote-offboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Remote Offboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.