List plan enrollments

get

http://api.wingspan.app/v2/plan-enrollment

Retrieve a list of plan enrollments for the authenticated user. Endpoint supports optional filtering, sorting, and pagination in QueryQL format.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter[planType][=]

string

enum

Filter by plan type

Allowed:

filter[planType][!=]

string

enum

Exclude plan type

Allowed:

filter[planType][in]

array of strings

Filter by multiple plan types

filter[planType][in]

Allowed:

filter[planType][notIn]

array of strings

Exclude multiple plan types

filter[planType][notIn]

Allowed:

filter[status][=]

string

enum

Filter by enrollment status

Allowed:

filter[status][!=]

string

enum

Exclude enrollment status

Allowed:

filter[status][in]

array of strings

Filter by multiple enrollment statuses

filter[status][in]

Allowed:

filter[status][notIn]

array of strings

Exclude multiple enrollment statuses

filter[status][notIn]

Allowed:

filter[sku][=]

string

Filter by plan SKU

filter[effectiveDate][=]

date

Filter by exact effective date

filter[effectiveDate][>]

date

Filter by effective date greater than

filter[effectiveDate][>=]

date

Filter by effective date greater than or equal to

filter[effectiveDate][<]

date

Filter by effective date less than

filter[effectiveDate][<=]

date

Filter by effective date less than or equal to

filter[endDate][=]

date

Filter by exact end date

filter[endDate][>]

date

Filter by end date greater than

filter[endDate][>=]

date

Filter by end date greater than or equal to

filter[endDate][<]

date

Filter by end date less than

filter[endDate][<=]

date

Filter by end date less than or equal to

filter[monthlyPremium][=]

number

Filter by exact monthly premium

filter[monthlyPremium][>]

number

Filter by monthly premium greater than

filter[monthlyPremium][>=]

number

Filter by monthly premium greater than or equal to

filter[monthlyPremium][<]

number

Filter by monthly premium less than

filter[monthlyPremium][<=]

number

Filter by monthly premium less than or equal to

sort

string

enum

Defaults to -updatedAt

Sort by field (prefix with - for descending)

page[size]

integer

≤ 100

Defaults to 50

Number of items per page

page[number]

integer

Defaults to 1

Page number

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200Successful response with list of plan enrollments

400Bad request

401Unauthorized

403Forbidden

500Internal server error

defaultUnexpected response