get_customers_per_affiliate
Get all customers connected to a specific affiliate using the affiliate ID. This read-only, paginated lookup simplifies affiliate customer reporting without modifying any school data.
Instructions
๐ข READ-ONLY ยท GET /v2/affiliates/{id}/customers
Get all customers per affiliate. Retrieves all the customers connected with the affiliate specified by the provided affiliate id. The customers are in sorted order, with the most recently created customer appearing first, and the list is paginated, with a limit of 20 customers 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. Related Affiliates tools: get_affiliate_payments, get_completed_affiliate_payouts, get_due_affiliate_payouts, get_leads_per_affiliate, get_upcoming_affiliate_payouts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Affiliate Id or email (encoded string) | |
| 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 |