Retrieve the session registrations of a center

This API helps you to retrieve the list of class session registrations in the specified center.

You must provide the appropriate details in the API request for the session_id parameter. Optionally, you can also specify the required details in the API request for the StatusString parameter to filter the search results by registration status in the API response. Refer to the Request Parameters table for more information.

Response Details

NameTypeDescription
resultsobjectObject that contains detailed information on the registered class sessions in the specified center. For more information, refer to the results Object table.
ErrorobjectObject that contains error message and error code details. For more information, refer to the Error Object table.

results Object

NameTypeDescription
UserIdguidUnique identifier of the guest who has registered for a class session.
SessionFKintUnique FK identifier of the registered class session.
SessionIdintUnique identifier of the registered class session.
RegistrationPKintUnique PK identifier of the class session for which the guest was registered.
RegistrationIdintUnique identifier of the class session for which the guest was registered.
indicatorsstringUnqiue indicators of the class session for which the guest was registered.
NamestringName of the guest.
LogDatastringData logged for the class session registration.
EmailstringEmail ID of the guest.
MobilestringMobile number of the guest.
PaymentTypestringMethod by which the guest paid for the registration of the class session.
PaymentSourcestringSource via which the guest paid for the registration of the class session.
BalanceBalancedoubleRemaining balance after guest made the payment.
BookedFromenumSource from which the session was booked. The possible values for this parameter are: 0 = Store, 1 = Mobile, 2 = Web, and 3 = BookingWizardAdvancedMode.
IsFreebooleanIndicates whether the class session can be registered for free.
IsFromWaitlistbooleanIndicates whether the guest belongs to the class session's waitlist.
statusenumIndicates the status of the class session: Active = 0, Cancelled = 1, Upcoming = 2, Inprogress = 3, and Completed = 4.
invoiceIdguidUnique 32-character identifier of the invoice for the class session registration.
AppGroupIdguidUnique 32-character identifier of the App Group for the class session registration.
registrationdtdatetimeDate on which the guest registered for the class session.
notesstringNotes added for the guest's class session registration.
UserCodeint?Unique code of the guest.
RedemptionTypeint?Type of redemption used by the guest.
SortOrderintOrder by which the center's class session registrations have been sorted.
LastUpdateddatetimeLatest date and time on which the center's class session registrations have been updated.
Language
Authorization
Header
Click Try It! to start a request and see the response here!