get_leads
Retrieve your LearnWorlds leads in paginated lists, newest first, 20 per page. Use it for read-only lead lookups and reporting.
Instructions
๐ข READ-ONLY ยท GET /v2/leads
Get leads. Returns a list with all the leads of the school. The leads are in sorted order, with the most recently created leads appearing first, and the list is paginated, with a limit of 20 leads per page.
Behavior: read-only lookup against the live school; creates, changes and deletes nothing. Auth (admin API token + Lw-Client id) is injected server-side, never by the model; calls are throttled to stay under LearnWorlds' 30-per-10s cap and retried on 429/5xx.
Parameters: results are paged โ walk them with page.
Returns: HTTP <status> followed by the LearnWorlds JSON response body. A non-2xx reply surfaces as a tool error with that status and the API error payload โ 401 bad/expired token, 403 not permitted, 404 no such record, 422 rejected input.
Use when: safe to call speculatively for lookups and reporting. Not for changing anything โ use the matching ๐ก write tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Filter by the page number. In case page number is higher than the maximum one, the results of last page will be returned |