EnrolmentsResponse
Defined in: v1/schemas.ts:511
The paginated wrapper returned by the /courses/:id/enrollments endpoint.
Remarks
Section titled “Remarks”The meta.per_page field has been observed returning 0 in live API
responses despite results being present. This appears to be a Teachable
API bug — do not rely on per_page from this endpoint to determine
page size.
Extends
Section titled “Extends”output<typeofEnrolmentsResponseSchema>
Properties
Section titled “Properties”enrollments
Section titled “enrollments”enrollments: {
completed_at?:string|null;enrolled_at?:string|null;expires_at?:string|null;percent_complete?:number;user_id:number; }[]
Defined in: v1/schemas.ts:498
completed_at?
Section titled “completed_at?”
optionalcompleted_at?:string|null
enrolled_at?
Section titled “enrolled_at?”
optionalenrolled_at?:string|null
expires_at?
Section titled “expires_at?”
optionalexpires_at?:string|null
percent_complete?
Section titled “percent_complete?”
optionalpercent_complete?:number
user_id
Section titled “user_id”user_id:
number
Inherited from
Section titled “Inherited from”z.infer.enrollments
optionalmeta?: {from?:number;number_of_pages?:number;page?:number;per_page?:number;to?:number;total?:number; }
Defined in: v1/schemas.ts:499
optionalfrom?:number
number_of_pages?
Section titled “number_of_pages?”
optionalnumber_of_pages?:number
optionalpage?:number
per_page?
Section titled “per_page?”
optionalper_page?:number
optionalto?:number
total?
Section titled “total?”
optionaltotal?:number
Inherited from
Section titled “Inherited from”z.infer.meta