ghl_course_list_enrollments
List contacts enrolled in a specific course product using product and location IDs, with cursor-based pagination to page through enrollment results.
Instructions
COURSES API — the {productId} path parameter is the course (product) id. List Product 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. Endpoint: GET /courses/products/{productId}/enrollments (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: limit, cursor — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"productId": "<productId>",
"locationId": "<locationId>"
},
"name": "ghl_course_list_enrollments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size (1-50) | |
| cursor | No | Opaque cursor from the previous page | |
| productId | Yes | Product id | |
| locationId | Yes | Location id or sub-account id is required. |