Benefit Offers
Get a employment benefit offers JSON schema
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
Scopes
Any one of the scopes in a token type's row is enough. all:read and all:write work too.
| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage company resources (company_admin) | View benefit offers (benefit_offer:read) | Manage benefit offers (benefit_offer:write) |
| Company-scoped access token (assertion) | Manage company resources (company_admin) | View benefit offers (benefit_offer:read) | Manage benefit offers (benefit_offer:write) |
| Customer API token | Manage company resources (company_admin) | View benefit offers (benefit_offer:read) | Manage benefit offers (benefit_offer:write) |
get/v1/employments/{employment_id}/benefit-offers/schema
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/employments/{employment_id}/benefit-offers/schema
- Auth
- OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: benefit_offer:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:write
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: benefit_offer:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer
Path parameters
employment_idstring uuid required
A unique identifier in UUID v4 format.
Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5
Unique identifier of the employment
Query parameters
Version of the form schema
Response
Success
Example response
{
"additionalProperties": false,
"properties": {
"health-group-slug": {
"allOf": [
{
"if": {
"properties": {
"filter": {
"const": "individual-slug"
}
}
},
"then": {
"properties": {
"value": {
"oneOf": [
{
"const": "health-individual-basic-slug",
"title": "Health Basic - Individual",
"x-jsf-presentation": {
"description": "Medical Insurance, Drug Prescriptions, Dental Insurance, Vision Insurance, Life insurance, and AD&D insurance are provided at a flat rate of 25,000 CAD.",
"meta": {
"details_url": "https://example.com",
"display_cost": "100 EUR",
"display_cost_disclaimer": "Costs may vary"
}
}
},
{
"const": "health-individual-premium-slug",
"title": "Health Premium - Individual",
"x-jsf-presentation": {
"description": "Health Premium Individual Description",
"meta": {
"details_url": "https://example.com",
"display_cost": "200 EUR",
"display_cost_disclaimer": "Costs may vary"
}
}
}
]
}
},
"required": [
"value"
]
}
},
{
"if": {
"properties": {
"filter": {
"const": "family-slug"
}
}
},
"then": {
"properties": {
"value": {
"oneOf": [
{
"const": "health-family-basic-slug",
"title": "Health Basic - Family",
"x-jsf-presentation": {
"description": "Health Basic Family Description",
"meta": {
"details_url": "https://example.com",
"display_cost": "200 EUR",
"display_cost_disclaimer": "Costs may vary"
}
}
},
{
"const": "health-family-premium-slug",
"title": "Health Premium - Family",
"x-jsf-presentation": {
"description": "Health Premium Family Description",
"meta": {
"details_url": "https://example.com",
"display_cost": "300 EUR",
"display_cost_disclaimer": "Costs may vary"
}
}
}
]
}
},
"required": [
"value"
]
}
}
],
"properties": {
"filter": {
"default": "individual-slug",
"oneOf": [
{
"const": "individual-slug",
"title": "Individual"
},
{
"const": "family-slug",
"title": "Family"
}
],
"type": "string",
"x-jsf-presentation": {
"inputType": "radio"
}
},
"value": {
"type": "string",
"x-jsf-presentation": {
"inputType": "radio"
}
}
},
"title": "Health",
"type": "object",
"x-jsf-order": [
"filter",
"value"
],
"x-jsf-presentation": {
"inputType": "fieldset",
"meta": {
"family": "health"
}
}
},
"life-group-slug": {
"properties": {
"value": {
"oneOf": [
{
"const": "life-premium-slug",
"title": "Life Insurance Premium",
"x-jsf-presentation": {
"description": "Life Insurance Premium Description",
"meta": {
"details_url": null,
"display_cost": "300 EUR",
"display_cost_disclaimer": "something something"
}
}
},
{
"const": "no",
"title": "I don't want to offer this benefit."
}
],
"type": "string",
"x-jsf-presentation": {
"inputType": "radio"
}
}
},
"required": [
"value"
],
"title": "Life",
"type": "object",
"x-jsf-order": [
"value"
],
"x-jsf-presentation": {
"inputType": "fieldset",
"meta": {
"family": "life"
}
}
}
},
"required": [
"health-group-slug",
"life-group-slug"
],
"type": "object",
"x-jsf-order": [
"health-group-slug",
"life-group-slug"
],
"x-jsf-presentation": {
"description": "We offer employee[only] supplemental, comprehensive coverage with Remote Health, provided in partnership with Allianz and flexible benefits platform - ThanksBEN. Plans available for selection are Premium and Standard. Dependent coverage available at employees' expense.",
"fine_print": "Benefit Details Fine Print",
"statement": {
"description": "A monthly benefits service fee of $15.00 USD will be charged for each employee enrolled\n in at least one benefit. <a href=\"https://support.remote.com/hc/en-us/articles/35121353075853-Understanding-Remote-s-Benefits-Service-Charge#h_01JPNB6H6HF3R1HHTSKNJ97NDE\">Learn more</a>",
"severity": "neutral",
"title": "Standardized benefits service fee"
},
"url": "https://example.com"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.