Skip to main content
GET
/
employee_benefit_types
List employee benefit types
curl --request GET \
  --url https://sandbox.nmbr.co/services/payroll/employee_benefit_types \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "accident_insurance_plan",
        "label": "Accidental Death and Dismemberment"
      },
      "links": {
        "self": "/employee_benefit_types/accident_insurance_plan"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "critical_illness",
        "label": "Critical Illness"
      },
      "links": {
        "self": "/employee_benefit_types/critical_illness"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "debt_relief",
        "label": "Debt Relief"
      },
      "links": {
        "self": "/employee_benefit_types/debt_relief"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "dental",
        "label": "Dental"
      },
      "links": {
        "self": "/employee_benefit_types/dental"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "employee_assistance_program",
        "label": "Employee Assistance Program"
      },
      "links": {
        "self": "/employee_benefit_types/employee_assistance_program"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "fondaction",
        "label": "Fondactions"
      },
      "links": {
        "self": "/employee_benefit_types/fondaction"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "fondaction_rrsp",
        "label": "Fondactions (RRSP)"
      },
      "links": {
        "self": "/employee_benefit_types/fondaction_rrsp"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "fonds_solidarite_ftq",
        "label": "Fonds de solidarité FTQ"
      },
      "links": {
        "self": "/employee_benefit_types/fonds_solidarite_ftq"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "fonds_solidarite_ftq_rrsp",
        "label": "Fonds de solidarité FTQ (RRSP)"
      },
      "links": {
        "self": "/employee_benefit_types/fonds_solidarite_ftq_rrsp"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "group_dependent_life_insurance",
        "label": "Group Dependent Life Insurance"
      },
      "links": {
        "self": "/employee_benefit_types/group_dependent_life_insurance"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "group_term_life_insurance",
        "label": "Group Term Life Insurance"
      },
      "links": {
        "self": "/employee_benefit_types/group_term_life_insurance"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "health",
        "label": "Health"
      },
      "links": {
        "self": "/employee_benefit_types/health"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "health_spending_account",
        "label": "Health Spending Account (HSA)"
      },
      "links": {
        "self": "/employee_benefit_types/health_spending_account"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "long_term_disability",
        "label": "Long-Term Disability (Group Plan)"
      },
      "links": {
        "self": "/employee_benefit_types/long_term_disability"
      }
    },
    {
      "id": "<id>",
      "object": "employee_benefit_type",
      "data": {
        "type": "non_group_long_term_disability",
        "label": "Long-Term Disability (Non-Group Plan)"
      },
      "links": {
        "self": "/employee_benefit_types/non_group_long_term_disability"
      }
    }
  ],
  "links": {
    "first": "/employee_benefit_types?page=1",
    "last": "/employee_benefit_types?page=3",
    "prev": null,
    "next": "/employee_benefit_types?page=2"
  },
  "meta": {
    "current_page": 1,
    "last_page": 3,
    "per_page": 15,
    "total": 31,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

OK

object
string
read-only

The type of the object in Nmbr ("list").

data
object[]