get_active_installments
Retrieve active installments from a LearnWorlds school. Filter by user, product, or product type, and page through results for payment tracking and reporting.
Instructions
๐ข READ-ONLY ยท GET /v2/installments/active
Get active installments. Return a list with active installments of users. The installments are in sorted order based on user's creation date in descending order, and the list is paginated, with a limit of 50 installments per page. To refine the list of installments, there are a number of query params outlined in the following section; In case more than one Query param is provided, then all of them will be applied (AND operator).
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, no results will be returned | |
| user_id | No | Filter by a user id or email (url encoded string) | |
| product_id | No | Filter by product Id | |
| product_type | No | Filter by product type |