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 Countries API

The Countries API from Remote — 6 operation(s) for countries.

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

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

This API exposes 6 operations across 6 paths, and defines 16 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 6 paths 16 schemas 6 GET

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 Countries 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 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Countries 6
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/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 16

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

ActionError
object
3 properties 3 required
ContractorContractDetailsResponse
object
Response for contractor contract details
1 property
ParameterError
object
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
EngagementAgreementDetailsResponse
object
Response for engagement agreement details
1 property
HolidaysResponse
object
Holidays response
1 property
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
UnprocessableEntityResponse
object
CountryFormResponse
object
Object with required and optional fields, its descriptions and suggested presentation
1 property
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…
CountriesResponse
object
List of countries supported by Remote API
1 property
Holiday
object
4 properties 2 required
UuidSlug
string
Identifier of the employment being terminated.
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
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-countries-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