Benefit Offers By Employment

List Benefit Offers By Employment

List benefit offers by employment.

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/benefit-offers

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/benefit-offers
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: benefit_offer:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: benefit_offer:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Example response

{
  "data": {
    "benefit_offers_by_employment": [
      {
        "benefit_offers": [
          {
            "benefit_group": {
              "id": "54297cfd-cf60-4cf4-a70f-ac2061d72b44",
              "name": "Health",
              "policy_end_date": "2024-12-31",
              "policy_start_date": "2024-01-01"
            },
            "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"
                }
              ]
            },
            "benefits": [
              {
                "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"
              }
            ],
            "costs": {
              "employee_cost": 234,
              "employer_cost": 44
            }
          }
        ],
        "costs": {
          "employee_cost": 234,
          "employer_cost": 44
        },
        "employment": {
          "country": {
            "alpha_2_code": "PT",
            "code": "PRT",
            "contractor_products_available": [
              "standard",
              "plus",
              "cor"
            ],
            "country_subdivisions": [
              {
                "code": "PT-06",
                "name": "Coimbra",
                "subdivision_type": "District"
              },
              {
                "code": "PT-11",
                "name": "Lisboa",
                "subdivision_type": "District"
              }
            ],
            "employment_agreement_preview_available": true,
            "eor_onboarding": true,
            "global_payroll_supported": true,
            "locked_benefits": "after_first_hire",
            "name": "Portugal",
            "region": "Europe",
            "subregion": "Southern Europe",
            "supported_json_schemas": [
              "additional_documents",
              "address_details",
              "administrative_details",
              "employment-basic-information",
              "bank_account_details",
              "contract_details",
              "emergency_contact"
            ]
          },
          "given_name": "Given Name",
          "id": "67897cfd-cf60-4cf4-a70f-ac2061d72984",
          "name": "Name",
          "surname": "Surname"
        }
      }
    ],
    "company_id": "79297cfd-cf60-4cf4-a70f-ac2061d72a74",
    "currency": {
      "code": "EUR",
      "name": "European Euro",
      "slug": "eur-3b840951-099f-4bd5-90b9-032f7bfe51d9",
      "symbol": "€"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.