Skip to main content
GET
/
v1
/
benefit
/
events
List benefit events
curl --request GET \
  --url https://api.plane.com/v1/benefit/events \
  --header 'Authorization: Bearer <token>'

Parameters

program
string
Filter by program.
entity
string
Filter by entity.
worker
string
Filter by worker.
type
string
Filter by event type. One of open_enrollment, new_hire, qle, or termination.
limit
integer
Number of events to return.
cursor
string
Pagination cursor.

Returns

Returns a list object containing Benefit event objects.