GET
/
payroll_benefits
/
{public_id}
cURL
curl --request GET \
  --url https://sandbox.withclasp.com/payroll_benefits/{public_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "member": "<string>",
  "line_of_coverage": "accident",
  "description": "<string>",
  "member_contribution": "<string>",
  "employer_contribution": "<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"

Path Parameters

​
public_id
string
required

Response

200 - application/json
​
id
string
required
​
member
string
required
​
line_of_coverage
enum<string>
required
  • accident - Accident
  • accidental_death - Accidental Death and Dismemberment
  • cancer - Cancer
  • dental - Dental
  • dependent_care_fsa - Dependent Care Flexible Spending Account
  • healthcare_fsa - Healthcare Flexible Spending Account
  • hospital_indemnity - Hospital Indemnity
  • hsa - Health Savings Account
  • life - Life
  • limited_purpose_fsa - Limited Purpose Flexible Spending Account
  • long_term_disability - Long Term Disability
  • medical - Medical
  • short_term_disability - Short Term Disability
  • vision - Vision
  • voluntary_critical_illness - Voluntary Critical Illness
  • voluntary_life - Voluntary Life
  • voluntary_accidental_death - Voluntary Accidental Death
  • voluntary_short_term_disability - Voluntary Short Term Disability
Available options:
accident,
accidental_death,
cancer,
dental,
dependent_care_fsa,
healthcare_fsa,
hospital_indemnity,
hsa,
life,
limited_purpose_fsa,
long_term_disability,
medical,
short_term_disability,
vision,
voluntary_critical_illness,
voluntary_life,
voluntary_accidental_death,
voluntary_short_term_disability
​
member_contribution
string<decimal>
required
​
employer_contribution
string<decimal>
required
​
description
string | null
Maximum length: 255
​
period
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
​
effective_start
string<date-time>
​
effective_end
string<date-time>
​
payroll_provider_external_id
string | null
Maximum length: 255
​
taxability
enum<string>
  • pre_tax - Pre-tax
  • post_tax - Post-tax
Available options:
pre_tax,
post_tax
​
coverage_type
enum<string>
  • member - Member Only
  • member_spouse - Member + Spouse
  • member_child - Member + Child
  • member_children - Member + Children
  • member_family - Member + Family
Available options:
member,
member_spouse,
member_child,
member_children,
member_family