Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Query Parameters

cursor
string

The pagination cursor value.

notification_type
enum<string>[]

Filter by one or more notification types.

  • enrollment_submitted - A member submitted their enrollment
  • enrollment_approved - A member's enrollment was approved
  • member_terminated - A member was terminated
  • welcome - A new hire should be welcomed and invited to enroll
  • newly_eligible - A member became eligible for benefits
  • dependent_age_out - A member's dependent is about to age out of coverage
  • open_enrollment_kickoff - An open enrollment window opened
  • open_enrollment_reminder - A member has not yet completed open enrollment
Available options:
enrollment_submitted,
enrollment_approved,
member_terminated,
welcome,
newly_eligible,
dependent_age_out,
open_enrollment_kickoff,
open_enrollment_reminder
page_size
integer

Number of results to return per page.

Filter to notifications about a specific object.

Filter by the type of the related object.

Response

200 - application/json
next
string | null
previous
string | null
results
object[]