Get Member Enrollment Summary

get

https://sandbox.lynx-fh.co/enrollments/list

Retrieves the summary of all member enrollments for the incoming client organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Enter values in the input boxes and click Try It! The API needs a token. Please read https://lynx-api.readme.io/docs for information on how to get an API token.

Query Params

clientOrgName

string

required

The name of the client organization

page

integer

Defaults to 1

Page number to be returned. If not specified, default is 1.

pageSize

integer

Defaults to 25

Maximum number of items to be returned per page. If not specified, default is 25.

sortValue

string

enum

Defaults to creationDate

The property by which the response is sorted

Allowed:

sortOrder

string

enum

Defaults to Descending

The sort direction

Allowed:

searchText

string

Search by Member Name or Client Member Id

clientMemberId

string

Unique client-side identifier for the member

status

string

enum

Status of member enrollment for the product

productName

string

The name of the product

startDate

string

Start date of date range

endDate

string

End date of date range

Responses

401

Not authorized

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Ok

400Bad request

404Not found