Retrieve Class Registrations

This API helps you to retrieve a list of registrations for the class sessions.

You must provide the appropriate details in the API request for the class_id, session_id and center_id parameters. Optionally, you can also specify the required expand parameters in the API request. Refer to the Request Parameters table for more information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error Object

codemessage
502 - InvalidInputThe UserId passed is not of the logged-in guest.
404 - Not FoundSomething went wrong.
502 - InvalidInputCurrently more than one sorter is not supported.
502 - InvalidInputCurrently only StartDate is supported as sorter.

Registration status values

StatusValue
Registered0
Cancelled1
NoShow2
SignedIn3
Waitlisted4
Substituted5
ClassCancelled6
Closed7
Enrolled8
Rejected9
Path Params
string
required

Unique identifier of a class.

Query Params
string
required

Mandatory Unique session id for which the registrations are to be returned.

string
required

Mandatory Unique 32 character identifier of the center for the session.

int32
required

Mandatory Unique identifier of the class.

string

Optional Populates the 'status_count' objects.

int32
Defaults to 1

Optional Number of display page for the records. Default value is 1.

int32
Defaults to 10

Optional Number of records displayed per page. Default value is 10.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json