Skip to main content

ReadEnrollmentApiPayload

Parameters to read one or many enrollment(s).

Properties

NameTypeDescriptionNotes
enrollment_design_namestrName of the Enrollment Design.
filter_criteriaList[object]Filter criteria based on which enrollments records should be fetched. If not provided, all records are fetched based on page size and number.[optional]
page_numberstrPage number of Enrollment records to be fetched. Default is 1.[optional]
page_sizestrMaximum number of Enrollment records to be fetched. Default is 50.[optional]

Example