Remote Benefits API

The Benefits API from Remote — 7 operation(s) for benefits.

Operations 9

GET /v1/employments/{employment_id}/benefit-offers Get employment benefit offers #
PUT /v1/employments/{employment_id}/benefit-offers Upserts employment benefit offers #
GET /v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema Show benefit renewal request schema #
GET /v1/benefit-renewal-requests List Benefit Renewal Requests #
GET /v1/employments/{employment_id}/benefit-offers/schema Get a employment benefit offers JSON schema #
GET /v1/benefit-renewal-requests/{benefit_renewal_request_id} Show Benefit Renewal Request #
POST /v1/benefit-renewal-requests/{benefit_renewal_request_id} Updates a Benefit Renewal Request Response #
GET /v1/benefit-offers/country-summaries List Benefit Offers #
GET /v1/benefit-offers List Benefit Offers By Employment #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/remote-benefits-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

remote-benefits-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Remote Benefits API
  version: 0.1.0
servers:
- url: https://gateway.remote.com/
  variables: {}
- url: https://gateway.remote-sandbox.com/
  variables: {}
security:
- OAuth2: []
tags:
- name: Benefits
paths:
  /v1/employments/{employment_id}/benefit-offers:
    get:
      callbacks: {}
      deprecated: false
      description: '## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) |

        '
      operationId: get_v1_employments_employment_id_benefit-offers
      parameters:
      - description: Starts fetching records after the given page
        example: 1
        in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          type: integer
      - description: Number of items per page
        example: 20
        in: query
        name: page_size
        required: false
        schema:
          default: 20
          minimum: 1
          type: integer
      - description: Unique identifier of the employment
        in: path
        name: employment_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Employments.BenefitOffers.ListBenefitOffers'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
      summary: Get employment benefit offers
      tags:
      - Benefits
    put:
      callbacks: {}
      deprecated: false
      operationId: put_v1_employments_employment_id_benefit-offers
      parameters:
      - description: Unique identifier of the employment
        in: path
        name: employment_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      - description: Version of the form schema
        example: 1
        in: query
        name: json_schema_version
        required: false
        schema:
          default: latest
          oneOf:
          - description: Specific version number
            minimum: 1
            type: integer
          - description: Use latest version
            enum:
            - latest
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Unified.Employment.UpsertBenefitOffersRequest'
        description: Upsert employment benefit offers request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      summary: Upserts employment benefit offers
      tags:
      - Benefits
  /v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema:
    get:
      callbacks: {}
      deprecated: false
      description: 'Returns the json schema of the `benefit_renewal_request` form for a specific request.

        This endpoint requires a company access token, as forms are dependent on certain

        properties of companies and their current employments.



        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |

        '
      operationId: get_v1_benefit-renewal-requests_benefit_renewal_request_id_schema
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Benefit Renewal Request Id
        example: 31b8e49b-aa1c-47af-849c-3d0a53e20e0d
        in: path
        name: benefit_renewal_request_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      - description: Version of the form schema
        example: 1
        in: query
        name: json_schema_version
        required: false
        schema:
          default: latest
          oneOf:
          - description: Specific version number
            minimum: 1
            type: integer
          - description: Use latest version
            enum:
            - latest
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitRenewalRequests.BenefitRenewalRequestFormResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
      summary: Show benefit renewal request schema
      tags:
      - Benefits
  /v1/benefit-renewal-requests:
    get:
      callbacks: {}
      deprecated: false
      description: 'List Benefit Renewal Requests for each country.


        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |

        '
      operationId: get_v1_benefit-renewal-requests
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Starts fetching records after the given page
        example: 1
        in: query
        name: page
        required: false
        schema:
          default: 1
          minimum: 1
          type: integer
      - description: Number of items per page
        example: 20
        in: query
        name: page_size
        required: false
        schema:
          default: 20
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitRenewalRequests.ListBenefitRenewalRequestResponse'
          description: Success
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
      summary: List Benefit Renewal Requests
      tags:
      - Benefits
  /v1/employments/{employment_id}/benefit-offers/schema:
    get:
      callbacks: {}
      deprecated: false
      description: '## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) |

        '
      operationId: get_v1_employments_employment_id_benefit-offers_schema
      parameters:
      - description: Unique identifier of the employment
        in: path
        name: employment_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      - description: Version of the form schema
        example: 1
        in: query
        name: json_schema_version
        required: false
        schema:
          default: latest
          oneOf:
          - description: Specific version number
            minimum: 1
            type: integer
          - description: Use latest version
            enum:
            - latest
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unified.Employments.BenefitOffersJSONSchemaResponse'
          description: Success
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
      summary: Get a employment benefit offers JSON schema
      tags:
      - Benefits
  /v1/benefit-renewal-requests/{benefit_renewal_request_id}:
    get:
      callbacks: {}
      deprecated: false
      description: 'Show Benefit Renewal Request details.


        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |

        '
      operationId: get_v1_benefit-renewal-requests_benefit_renewal_request_id
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Benefit Renewal Request Id
        example: 31b8e49b-aa1c-47af-849c-3d0a53e20e0d
        in: path
        name: benefit_renewal_request_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitRenewalRequests.BenefitRenewalRequestResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:read
        - benefit_renewal:write
        - company_admin
        - all:write
        - all:read
      summary: Show Benefit Renewal Request
      tags:
      - Benefits
    post:
      callbacks: {}
      deprecated: false
      description: 'Updates a Benefit Renewal Request with the given response.


        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) |

        '
      operationId: post_v1_benefit-renewal-requests_benefit_renewal_request_id
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Benefit Renewal Request Id
        example: 31b8e49b-aa1c-47af-849c-3d0a53e20e0d
        in: path
        name: benefit_renewal_request_id
        required: true
        schema:
          $ref: '#/components/schemas/UuidSlug'
      - description: Version of the form schema
        example: 1
        in: query
        name: json_schema_version
        required: false
        schema:
          default: latest
          oneOf:
          - description: Specific version number
            minimum: 1
            type: integer
          - description: Use latest version
            enum:
            - latest
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BenefitRenewalRequests.UpdateBenefitRenewalRequest'
        description: Benefit Renewal Request Response
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:write
        - company_admin
        - all:write
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_renewal:write
        - company_admin
        - all:write
      summary: Updates a Benefit Renewal Request Response
      tags:
      - Benefits
  /v1/benefit-offers/country-summaries:
    get:
      callbacks: {}
      deprecated: false
      description: 'List benefit offers for each country.



        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) |

        '
      operationId: get_v1_benefit-offers_country-summaries
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountrySummariesResponse'
          description: Success
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Unprocessable Entity
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
      summary: List Benefit Offers
      tags:
      - Benefits
  /v1/benefit-offers:
    get:
      callbacks: {}
      deprecated: false
      description: 'List benefit offers by employment.



        ## Scopes


        | Category | Read only Scope | Write only Scope (read access implicit) |

        |---|---|---|

        | Manage company resources (`company_admin`) | View benefit offers (`benefit_offer:read`) | Manage benefit offers (`benefit_offer:write`) |

        '
      operationId: get_v1_benefit-offers
      parameters:
      - description: 'Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.


          The refresh token needs to have been obtained through the Authorization Code flow.

          '
        example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitOfferByEmploymentResponse'
          description: Success
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not Found
      security:
      - CustomerAPIToken:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
        OAuth2AuthorizationCode:
        - https://gateway.remote.com/company.manage
        - benefit_offer:read
        - benefit_offer:write
        - company_admin
        - all:write
        - all:read
      summary: List Benefit Offers By Employment
      tags:
      - Benefits
webhooks:
  benefit_renewal_request.created:
    post:
      deprecated: false
      description: This event is triggered when a Benefit Renewal Request is created.
      summary: benefit_renewal_request.created
      tags:
      - Benefits
      responses:
        2XX:
          description: Any 200 response confirms that the webhook was delivered.
      security: []
      operationId: benefit_renewal_request.created
      requestBody:
        content:
          application/json:
            schema:
              required:
              - event_type
              - benefit_renewal_request_id
              - country_code
              - company_id
              example:
                benefit_renewal_request_id: ba310525-9282-40c9-8977-14d844bf891a
                company_id: d2091b1e-b1a4-437a-91ea-2809ffbb6d59
                country_code: FRA
                event_type: benefit_renewal_request.created
              properties:
                company_id:
                  type: string
                  description: The unique identifier of the related company.
                country_code:
                  type: string
                  description: The ISO 3166-1 3-letter country code.
                event_type:
                  type: string
                  description: The webhook event type identifier.
                benefit_renewal_request_id:
                  type: string
                  description: The unique identifier of the benefit renewal request.
components:
  schemas:
    BenefitProvider:
      additionalProperties: false
      description: 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.
      example:
        id: 88297cfd-cf60-4cf4-a70f-ac2861d92b87
        name: Health Provider
      properties:
        id:
          description: The unique identifier (UUID) of the benefit provider.
          type: string
        name:
          description: The name of the insurance carrier or benefit provider (e.g., "Allianz", "Bupa").
          type: string
      required:
      - id
      - name
      title: BenefitProvider
      type:
      - object
      - 'null'
    OfferedBenefitTier:
      additionalProperties: false
      description: A benefit tier that has been offered to employees, combined with enrollment statistics for that tier.
      example:
        benefit_tier:
          description: This is the premium tier for 2023 that includes medical, dental and vision benefits.
          id: 66297cfd-cf60-4cf4-a70f-ac2561d92b04
          name: Premium 2023 (Medical, Dental and Vision)
          providers:
          - id: 88297cfd-cf60-4cf4-a70f-ac2861d92b87
            name: Health Provider
        employee_stats:
          number_of_employees_enrolled: 10
          number_of_employees_offered: 12
      properties:
        benefit_tier:
          $ref: '#/components/schemas/BenefitTier'
        employee_stats:
          $ref: '#/components/schemas/EmployeeStats'
      required:
      - benefit_tier
      - employee_stats
      title: OfferedBenefitTier
      type: object
    UnauthorizedResponse:
      description: Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorization header.
      example:
        message: Unauthorized
      properties:
        message:
          pattern: Unauthorized
          type: string
      required:
      - message
      title: UnauthorizedResponse
      type: object
    Unified.Employment.BenefitGroup:
      additionalProperties: false
      example:
        filter:
          name: Benefit Group
          slug: 663e0b79-c893-45ff-a1b2-f6dcabc098b5
        name: Benefit Group
        slug: 663e0b79-c893-45ff-a1b2-f6dcabc098b5
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/Unified.MinimalBenefitGroup'
          example:
            name: Benefit Group
            slug: 663e0b79-c893-45ff-a1b2-f6dcabc098b5
          title: MaybeUnified.MinimalBenefitGroup
          type:
          - object
          - 'null'
        name:
          type:
          - string
          - 'null'
        slug:
          $ref: '#/components/schemas/Slug'
      required:
      - name
      - slug
      - filter
      title: Unified.Employment.BenefitGroup
      type: object
    Currency:
      description: The type of money in general use in a particular country
      example:
        code: EUR
        name: European Euro
        slug: eur-3b840951-099f-4bd5-90b9-032f7bfe51d9
        symbol: €
      properties:
        code:
          type: string
        name:
          type: string
        slug:
          type: string
        symbol:
          type: string
      required:
      - code
      - slug
      - symbol
      title: Currency
      type: object
    Unified.MinimalBenefitGroup:
      example:
        name: Benefit Group
        slug: 663e0b79-c893-45ff-a1b2-f6dcabc098b5
      properties:
        name:
          type:
          - string
          - 'null'
        slug:
          $ref: '#/components/schemas/Slug'
      required:
      - name
      - slug
      title: Unified.MinimalBenefitGroup
      type: object
    BenefitGroup:
      additionalProperties: false
      description: A category of benefits (e.g., "Health", "Dental", "Life Insurance") with a defined policy period. Each group contains one or more tiers representing different coverage levels.
      example:
        id: 54297cfd-cf60-4cf4-a70f-ac2061d72b44
        name: Health
        policy_end_date: '2024-12-31'
        policy_start_date: '2024-01-01'
      properties:
        id:
          description: The unique identifier (UUID) of the benefit group.
          type: string
        name:
          description: The name of the benefit category (e.g., "Health", "Dental", "Life Insurance").
          type: string
        policy_end_date:
          description: The date when the policy period ends for this benefit group (ISO 8601 format). Benefits may need to be renewed after this date.
          format: date
          type: string
        policy_start_date:
          description: The date when the policy period begins for this benefit group (ISO 8601 format).
          format: date
          type: string
      required:
      - id
      - name
      - policy_start_date
      - policy_end_date
      title: BenefitGroup
      type: object
    NullableMinimalBenefitTier:
      additionalProperties: false
      example:
        description: A tier for testing purposes
        display_cost: ~$100
        id: 163d8f6c-2440-4f45-918b-d095f9e0ef79
        name: Premium
      properties:
        description:
          description: A description of what this tier includes.
          type: string
        display_cost:
          description: A human-readable cost estimate for this tier (e.g., "~$100"). Null if cost is not available.
          type:
          - string
          - 'null'
        id:
          description: The unique identifier (UUID) of the benefit tier.
          type: string
        name:
          description: The name of the benefit tier (e.g., "Premium", "Standard").
          type: string
      required:
      - id
      - name
      - description
      title: NullableMinimalBenefitTier
      type:
      - object
      - 'null'
    TooManyRequestsResponse:
      description: 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.
      example:
        message: Too many requests
      properties:
        message:
          pattern: Too many requests
          type: string
      title: TooManyRequestsResponse
      type: object
    NotFoundResponse:
      description: Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
      example:
        message: '{resource} not found'
      properties:
        message:
          description: A message indicating which resource was not found.
          pattern: Not Found
          type: string
      title: NotFoundResponse
      type: object
    Benefit:
      additionalProperties: false
      description: 'Benefits with status enrolled have their summed costs in costs.

        Benefits with status offered have their summed costs in projected_costs.

        Benefit-offers where the employer opted-out have benefit_tier: null in the response.

        '
      example:
        costs:
          employee_cost: 234
          employer_cost: 44
        coverage_end_date: '2025-02-28'
        coverage_start_date: '2024-03-18'
        id: 562977cfd-cf60-4cf4-a70f-ac2061d709088
        name: benefit name
        projected_costs: null
        provider:
          id: 88297cfd-cf60-4cf4-a70f-ac2861d92b87
          name: Health Provider
        status: enrolled
        type: benefit type
      properties:
        costs:
          $ref: '#/components/schemas/Costs'
        coverage_end_date:
          description: The date when benefit coverage ends (ISO 8601).
          format: date
          type: string
        coverage_start_date:
          description: The date when benefit coverage begins (ISO 8601).
          format: date
          type: string
        id:
          description: The unique identifier (UUID) of the benefit.
          type: string
        name:
          description: The name of the benefit (e.g., "Health Insurance", "Dental Plan").
          type: string
        projected_costs:
          $ref: '#/components/schemas/Costs'
        provider:
          $ref: '#/components/schemas/BenefitProvider'
        status:
          description: 'The enrollment status of this benefit for the employee.


            - `offered`: The benefit has been offered but the employee has not yet enrolled.

            - `enrolled`: The employee is actively enrolled

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/remote/refs/heads/main/openapi/remote-benefits-api-openapi.yml