Skip to main content
Glama

get_completed_affiliate_payouts

Read-onlyIdempotent

Retrieve completed affiliate payouts for a given affiliate ID or email. The read-only endpoint returns paginated results, newest first, for reporting or verification.

Instructions

๐ŸŸข READ-ONLY ยท GET /v2/affiliates/{id}/payouts/completed

Get completed affiliate payouts. Returns a list with all the completed payouts related to the provided affiliate. The payouts are in sorted order, with the most recently created payouts appearing first, and the list is paginated, with a limit of 20 payouts 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. 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_due_affiliate_payouts, get_upcoming_affiliate_payouts, get_affiliate_payments, get_customers_per_affiliate, get_leads_per_affiliate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesAffiliate Id or email (encoded string)

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv1.0.0

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false, but the description adds meaningful behavioral context: it performs a read-only lookup against the live school, creates/changes/deletes nothing, injects auth server-side, throttles under the rate cap, retries on 429/5xx, and explains error statuses. This exceeds what the annotations alone convey and does not contradict them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and front-loaded with the tool's purpose, then uses labeled sections for Behavior, Returns, and Use when. Every sentence adds value, including the rate-limit and retry details, and there is no redundant repetition of schema fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity, one parameter, and no output schema, the description is complete: it explains the return format, pagination and sorting, error semantics, auth handling, rate limiting, and read-only safety. An agent has enough information to invoke it correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema covers 100% of the single parameter, describing it as 'Affiliate Id or email (encoded string)', so the description does not need to add much. The description adds minor context by framing it as 'the provided affiliate' and showing the endpoint path, but the schema already carries the semantic weight. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource ('Get completed affiliate payouts') and immediately clarifies scope: all completed payouts related to a given affiliate. It also distinguishes the tool from sibling payout tools by naming 'completed' and listing related Affiliates tools, so an agent can tell it apart without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use the tool ('safe to call speculatively for lookups and reporting') and when not to ('Not for changing anything โ€” use the matching ๐ŸŸก write tool'). It also names related Affiliates tools as alternatives, including get_due_affiliate_payouts and get_upcoming_affiliate_payouts, giving clear routing context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ohneben/Learnworlds-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server