Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Benefit Offers

Get employment benefit offers

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

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

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