Remote Benefits API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Benefits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
9 operations
across 7 paths,
and defines 45 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/.
The identity and technical contract details declared by the specification.
Remote Benefits 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.
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
BenefitRenewalRequests.BenefitRenewalRequestFormResponse
object
Benefit Renewal Request Form Response, an object with required and optional fields, its descriptions and suggested presentation.
1 property
Unified.Employment.BenefitOffer
object
The benefit offer for an employment schema
2 properties
2 required
ParameterError
object
3 properties
3 required
BenefitRenewalRequests.MinimalBenefitRenewalResponse
object
2 properties
2 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
BenefitRenewalRequests.BenefitRenewalRequestResponse
object
Benefit Renewal Request Response
1 property
1 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
OfferedBenefitGroup
object
A benefit group that has been offered to employees, including enrollment statistics aggregated across all tiers and the individual offered tiers with their own…
3 properties
3 required
Unified.MinimalBenefitGroup
object
2 properties
2 required
OfferedBenefitTier
object
A benefit tier that has been offered to employees, combined with enrollment statistics for that tier.
2 properties
2 required
BenefitRenewalRequests.UpdateBenefitRenewalRequest
object
Upsert benefit offers Renewal Request. This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on…
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
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
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
UnprocessableEntityResponse
object
Country
object
A supported country on Remote
11 properties
3 required
Unified.Employment.BenefitGroup
object
3 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…
BenefitRenewalRequests.ListBenefitRenewalRequestResponse
object
Response schema listing many benefitrenewalrequests
1 property
ActionError
object
3 properties
3 required
EmployeeStats
object
Enrollment statistics for a benefit at a given level (country, group, or tier). Shows how many employees have been offered the benefit versus how many are acti…
2 properties
2 required
CountrySummariesResponse
object
Response containing a company's benefit offering summaries broken down by country. Each country includes aggregate enrollment statistics and details of all off…
1 property
1 required
BenefitOffersByEmployment
object
3 properties
3 required
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
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
BenefitOfferByEmploymentResponse
object
1 property
1 required
CountrySummary
object
A per-country summary of benefit offerings, including aggregate enrollment statistics and a breakdown of all offered benefit groups and their tiers for that co…
3 properties
3 required
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
NullableMinimalBenefitTier
object
4 properties
3 required
Employments.BenefitOffers.ListBenefitOffers
object
The list of benefit offers for an employment schema
1 property
1 required
Unified.Employment.BenefitTier
object
3 properties
UuidSlug
string
Identifier of the employment being terminated.
BenefitRenewalRequests.BenefitRenewalRequest
object
10 properties
9 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
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties
1 required
BenefitOffer
object
4 properties
4 required
Unified.Employments.BenefitOffersJSONSchemaResponse
object
JSON schema response for benefit offers
1 property
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
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
Unified.Employment.UpsertBenefitOffersRequest
object
Upsert benefit offers request. As its properties may vary depending on the employment, you must query the [Show benefit offers schema](tag/benefits/operation/g…
BenefitRenewalRequests.MinimalBenefitGroup
object
A lightweight benefit group reference used in renewal requests.
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
