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 Getting Started API

The Getting Started API from Remote — 8 operation(s) for getting started.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

8 operations 8 paths 33 schemas 7 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 Getting Started 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 8

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

Getting Started 8
GET
/v1/countries/{country_code}/contractor-contract-details
Show contractor contract details
get_v1_countries_country_code_contractor-contract-details 3 params → 200400401404422429
GET
/v1/countries/{country_code}/holidays/{year}
List all holidays of a country
get_v1_countries_country_code_holidays_year 4 params → 200401404422
GET
/v1/countries/{country_code}/{form}
Show form schema
get_v1_countries_country_code_form 8 params → 200400401404422429
GET
/v1/countries/{country_code}/engagement-agreement-details
Show engagement agreement details
get_v1_countries_country_code_engagement-agreement-details 1 param → 200400401404422429
GET
/v1/countries
List countries
get_v1_countries 1 param → 200400401404422429
GET
/v1/identity/current
Get token identity
get_v1_identity_current 1 param → 201400401404422429
POST
/auth/oauth2/token
Token
post_auth_oauth2_token body → 200400401404422429
GET
/v1/countries/{country_code}/legal_entity_forms/{form}
Show legal entity administrative details form schema
get_v1_countries_country_code_legal_entity_forms_form 5 params → 200400401404422429

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Country (11 properties), Holiday (4 properties), IdentityUser (4 properties), ActionError (3 properties). Each schema is shown below with its type and property counts.

ClientCredentialsParams
object
2 properties 2 required
ParameterError
object
3 properties 3 required
AuthorizationCodeParams
object
2 properties 2 required
RefreshTokenResponse
object
OAuth2TokenParams
object
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
EngagementAgreementDetailsResponse
object
Response for engagement agreement details
1 property
HolidaysResponse
object
Holidays response
1 property
UnprocessableEntityResponse
object
IdentityCompany
object
The company that the current authentication token is scoped to. Only present when using a company-scoped access token or customer API token.
2 properties 2 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…
IdentityCompanyAccessTokenResponse
object
Returned when the current token was obtained via the OAuth2 Authorization Code flow and is scoped to a specific company managed by an integration partner. Cont…
1 property 1 required
CountriesResponse
object
List of countries supported by Remote API
1 property
Holiday
object
4 properties 2 required
ActionError
object
3 properties 3 required
IdentityCurrentResponse
object
The response from GET /v1/identity/current. Returns information about the entities associated with the current authentication token. The shape of the response…
IdentityUser
object
The user (company manager) associated with the current authentication token. Represents the person who authorized access to the company's data.
4 properties 4 required
ClientCredentialsResponse
object
BaseTokenResponse
object
3 properties
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
IdentityCustomerAccessTokenResponse
object
Returned when the current token is a Customer API Token. These tokens are used by companies accessing their own data directly (not through an integration partn…
1 property 1 required
RefreshTokenParams
object
2 properties 2 required
UuidSlug
string
Identifier of the employment being terminated.
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties 1 required
OAuth2Tokens
object
ContractorContractDetailsResponse
object
Response for contractor contract details
1 property
AuthorizationCodeResponse
object
IdentityClientCredentialsResponse
object
Returned when the current token was obtained via the OAuth2 Client Credentials flow. Contains the integration's client ID and details, but no company or user i…
1 property 1 required
CountryFormResponse
object
Object with required and optional fields, its descriptions and suggested presentation
1 property
AssertionTokenParams
object
The assertion token is a JWT token that contains the following claims: - sub: The subject of the token, in one of the following formats: - urn:remote-api:emplo…
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
IdentityIntegration
object
Details about the integration partner associated with the current authentication token.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-getting-started-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
#Getting Started
← Back to R APIs
API Details
ID
remote:remote-getting-started-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