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 Benefit Offers By Employment API

The Benefit Offers By Employment API from Remote — 1 operation(s) for benefit offers by employment.

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

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

This API exposes 1 operation across 1 path, and defines 13 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/.

1 operations 1 paths 13 schemas 1 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 Benefit Offers By Employment 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Benefit Offers By Employment 1
GET
/v1/benefit-offers
List Benefit Offers By Employment
get_v1_benefit-offers 1 param → 200404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Country (11 properties), Benefit (9 properties), BenefitOffersEmployment (5 properties), BenefitOffer (4 properties). Each schema is shown below with its type and property counts.

BenefitOffer
object
4 properties 4 required
BenefitOffersByEmployment
object
3 properties 3 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties 1 required
Benefit
object
Benefits with status enrolled have their summed costs in costs. Benefits with status offered have their summed costs in projectedcosts. Benefit-offers where th…
9 properties 9 required
Country
object
A supported country on Remote
11 properties 3 required
BenefitTier
object
A specific coverage level within a benefit group. For example, a "Health" benefit group might have tiers like "Basic", "Standard", and "Premium", each with dif…
4 properties 4 required
BenefitOfferByEmploymentResponse
object
1 property 1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
BenefitProvider
object
The insurance carrier or provider that underwrites a benefit tier. May be null if the benefit tier does not have a specific external provider assigned.
2 properties 2 required
Costs
object
The cost breakdown between employee and employer for a benefit. Amounts are in the company's billing currency, in cents.
2 properties 2 required
Currency
object
The type of money in general use in a particular country
4 properties 3 required
BenefitOffersEmployment
object
A lightweight employment representation used in benefit offer listings.
5 properties 5 required
BenefitGroup
object
A category of benefits (e.g., "Health", "Dental", "Life Insurance") with a defined policy period. Each group contains one or more tiers representing different…
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-benefit-offers-by-employment-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 Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API
Remote Companies API