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 Travel Letters API

The Travel Letters API from Remote — 2 operation(s) for travel letters.

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

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

This API exposes 4 operations across 2 paths, and defines 17 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/.

4 operations 2 paths 17 schemas 2 GET1 PATCH1 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 Travel Letters 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 4

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

Travel Letters 4
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

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are TravelLetterRequest (20 properties), Country (11 properties), ApprovedTravelLetter (5 properties), CountrySubdivision (3 properties). Each schema is shown below with its type and property counts.

DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
ActionError
object
3 properties 3 required
ParameterError
object
3 properties 3 required
UuidSlug
string
Identifier of the employment being terminated.
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
UpdateTravelLetterRequestParams
Schema for updating travel letter request parameters
DeclinedTravelLetter
object
Schema for declined travel letter
3 properties 2 required
ListTravelLettersResponse
object
Response schema listing many travelletterrequests
1 property
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
Country
object
A supported country on Remote
11 properties 3 required
ApprovedTravelLetter
object
Schema for approved travel letter
5 properties 4 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
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
TravelLetterResponse
object
Schema for travel letter request
1 property 1 required
TravelLetterUser
object
A user associated with a travel letter request (either the employee or the employer approver).
3 properties 3 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-travel-letters-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