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

Remote Resignations API

The Resignations API from Remote — 3 operation(s) for resignations.

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

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

This API exposes 3 operations across 3 paths, and defines 18 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/.

3 operations 3 paths 18 schemas 2 GET1 PUT

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 Resignations 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 3

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

Resignations 3
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/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

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ResignationAfterStartDateRequestParams (15 properties), ResignationAfterStartDate (10 properties), ResignationBeforeStartDate (4 properties), ActionError (3 properties). Each schema is shown below with its type and property counts.

ParameterError
object
3 properties 3 required
ResignationResponse
object
Resignation response
1 property
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
ValidateResignationRequestParams
object
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
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ResignationBeforeStartDateRequestParams
object
2 properties 1 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.
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
ResignationAfterStartDateRequestParams
object
15 properties 7 required
ResignationFile
object
2 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
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property 1 required
ActionError
object
3 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-resignations-api-openapi.yml Raw ↑

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