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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Remote

Remote Terminations API

The Terminations API from Remote — 5 operation(s) for terminations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Remote Terminations API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Terminations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

6 operations 5 paths 23 schemas 5 GET1 POST

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 Terminations 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 6

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

Terminations 6
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/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

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are TerminationOffboarding (19 properties), TerminationDetailsParams (16 properties), ResignationOffboarding (14 properties), V2Offboarding (9 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
TerminationDetailsParams
object
16 properties 6 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
ListOffboardingResponse
object
Response schema listing many offboardings
1 property
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
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
UnprocessableEntityResponse
object
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…
ActionError
object
3 properties 3 required
V2ListOffboardingResponse
object
Response schema listing many offboardings
1 property
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
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
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…
ResignationOrTerminationOffboarding
object
CreateOffboardingParams
object
3 properties 3 required
Offboarding
object
A wrapper containing an offboarding record, which can be either a termination (employer-initiated) or a resignation (employee-initiated).
1 property
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-terminations-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
AE Profile APIs.io
Remote Administrative Details API
AE Profile APIs.io
Remote Background Checks API
AE Profile APIs.io
Remote Bank Account Details API
AE Profile APIs.io
Remote Basic Information API
AE Profile APIs.io
Remote Benefit Offers API
AE Profile APIs.io
Remote Benefit Offers By Employment API
AE Profile APIs.io
Remote Benefit Renewals API
AE Profile APIs.io
Remote Benefits API
AE Profile APIs.io
Remote Billing Address Details API
AE Profile APIs.io
Remote Billing API
AE Profile APIs.io
Remote Billing Documents API
AE Profile APIs.io
#Terminations
← Back to R APIs
API Details
ID
remote:remote-terminations-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