List benefit enrollments

get

https://api.wingspan.app/v3/platform/benefit-enrollments

Returns a paginated list of the BenefitEnrollments held within the caller's account scope, for every benefit product, whether or not the catalog bills it. Filterable by productId, status and accountIds. Sortable on createdAt (the default, newest first), updatedAt, effectiveDate and terminationDate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

object

Pagination query parameters. Serializes as page[size] and page[token].

sort

object

Sort query parameters. Serialize as sort[field]=asc or sort[field]=desc. Default ordering is endpoint-specific.

filter

object

Filters use deep-object query parameters, for example filter[status][eq]=Active. Every filter here is IN-style: filter[field][anyOf][]=value, repeated to match any of several values, with filter[field][eq]=value as the single-value spelling.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Paginated list of enrollments

401Unauthenticated

403Forbidden