Skip to main content
EnrollmentVersion: v3New

List Product Enrollments

GET/courses/products/{productId}/enrollments

List contacts enrolled in a product. Requires a Location token with courses.readonly. Send Version: v3. Reads user_purchases in the bound location. Does not return email or lesson progress. Cursor encodes createdAt and id.

Authorizations

Authorizationstringheaderrequired

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

Scope:courses.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

productIdstring<uuid>required

Product id

Possible values: non-empty

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Query Parameters

limitstring

Page size (1-50)

Possible values: non-empty

Example:15
cursorstring

Opaque cursor from the previous page

Possible values: non-empty

Example:eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTIwVDEwOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItNDJkMy1hNDU2LTQyNjYxNDE3NDAwMSJ9
locationIdstringrequired

Location id or sub-account id is required.

Possible values: non-empty

Example:ve9EPM428h8vShlRW1KT

Response

Success

enrollmentsobject[]required
nextCursorstringnullablerequired