List Payroll Benefits

Returns a list of all payroll benefit deductions.

GET /payroll_benefits

cURL

cURL

curl --request GET \
  --url https://sandbox.withclasp.com/payroll_benefits \
  --header 'Authorization: Bearer <token>'

200

{
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "member": "<string>",
      "line_of_coverage": "accident",
      "member_contribution": "<string>",
      "employer_contribution": "<string>",
      "description": "<string>",
      "period": "weekly",
      "effective_start": "2023-11-07T05:31:56Z",
      "effective_end": "2023-11-07T05:31:56Z",
      "payroll_provider_external_id": "<string>",
      "taxability": "pre_tax",
      "coverage_type": "member"
    }
  ]
}

Authorizations

Authorization · string · header · required

API Key authentication with required prefix "Bearer"

Query Parameters

employer · string

cursor · string

The pagination cursor value.

page_size · integer

Number of results to return per page.

Response

200 - application/json

next · string | null

previous · string | null

results · object[]

Show child attributes