get_payments
Retrieve a paginated list of payments from LearnWorlds, filterable by user, product, affiliate, product type, and creation date.
Instructions
๐ข READ-ONLY ยท GET /v2/payments
Get payments. Returns a list with all the payments. The payments are in sorted order, with the most recently created payment appearing first, and the list is paginated, with a default limit of 50 payments per page. To refine the list of payments, 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 and size each page with items_per_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 Payments tools: get_invoice_link_per_payment, get_payment.
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 | |
| user_id | No | Filter by user id or email (encoded string) | |
| product_id | No | Filter by product id | |
| affiliate_id | No | Filter by affiliate id or email (encoded string) | |
| product_type | No | Filter by product type | |
| created_after | No | Filter by payment creation after the given datetime (expected in UNIX timestamp format) | |
| created_before | No | Filter by payment creation before the given datetime (expected in UNIX timestamp format) | |
| items_per_page | No | Filter by the items per page number |