v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Benefit Offers

Get a employment benefit offers JSON schema

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
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

Path parameters

employment_idstring uuid required

Identifier of the employment being terminated.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Unique identifier of the employment

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

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"
  }
}