Skip to main content
GET
Get a list of all Group Enrollments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id
string<uuid>
required

The unique identifier of the group for which you would like to view group enrollments

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Query Parameters

effective_date
string

The relative date on which to view the state of the record

status
string

The status of the group enrollments you would like to view

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json

Successful Response - Returns all matching Group Enrollments

meta
object
required

Metadata associated with the response data

response
object[]
required

List of group enrollment results