ghl_course_list_completions
Lists course lesson completions for a specified learner, or returns a paginated contact rollup for course creators.
Instructions
COURSES API — the {productId} path parameter is the course (product) id. List Completions With contactId, return that learner's completed lessons. Without contactId, return a paginated creator rollup by contact. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/completions (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly Pagination params: pageSize — 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_completions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pageSize | No | Creator page size (1-50). Ignored when contactId is set. | |
| contactId | No | CRM contact id. Required for per-learner completions. Omit for the creator rollup. | |
| productId | Yes | Product id | |
| locationId | Yes | Location id or sub-account id is required. | |
| pageNumber | No | Creator page number (1-based). Ignored when contactId is set. |