Get employment benefit offers

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

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)

get/v1/employments/{employment_id}/benefit-offers

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/employments/{employment_id}/benefit-offers
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, benefit_offer:read, benefit_offer:write, company_admin, all:write, all:read)

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

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": [
    {
      "benefit_group": {
        "filter": {
          "name": "Benefit Group",
          "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
        },
        "name": "Benefit Group",
        "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      },
      "benefit_tier": {
        "display_cost": "$1337 + pension",
        "name": "Benefit Tier 1",
        "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 65 revisions of this API.