398aef013538
latestOpenAPI 3.0.12026-08-11241391711.5 KBRetrieves affiliate networks, optionally filtered and paged.
Filter and page server-side rather than fetching the whole collection and filtering locally.
Filters combine with AND, and each filter parameter's own description states whether it matches exactly or as a case-insensitive substring. Filters are applied before paging, so a page contains only entities matching the filters.
Send limit to page; without it this endpoint returns the whole matching collection - but the MCP list_ tools default limit to 100, so through them a bare call is one page, not the complete collection.
Paging is by cursor, not by position: a response that has more to give carries nextId, and you get the following page by sending it back as the nextId parameter with the same filters. When nextId is absent the collection is exhausted - there is no need for a further request to discover that, and no total count to compare against. Do not construct a cursor yourself; ids are opaque here.
Freshness (If-Modified-Since) is judged over every entity of this type, not over the filtered page: a change that moves an entity out of your filter, or onto a page you are not reading, still answers 200. So the header combines with both filtering and paging, at the cost of the occasional 200 for a view that did not itself change.
Query parameters
Filters by the free-text note. Match: contains, case-insensitive.
Cursor to continue from, taken verbatim from the nextId of the previous response. Only allowed together with limit. Omit it for the first page.
Filters by conversion tracking method. Match: exact. One of S2S_POSTBACK_URL, TRACKING_SCRIPT, TRACKING_PIXEL, TRACKING_PIXEL_URL, MANUAL_UPLOAD, API_INTEGRATION.
Filters by name. Match: contains, case-insensitive.
Maximum number of entities to return (page size), at most 1000. This endpoint applies no implicit default - unlike GET /report - so omitting limit returns the whole matching collection. The Voluum MCP list_ tools are the exception: they send limit=100 whenever the caller does not, so their responses are always one page and never a guaranteed complete collection. A response that has more to give carries nextId; the applied limit is not echoed back, since a page carrying nextId is by definition full.
Whether deleted entities should be included in the response.
Names of the fields that should be included in the response.
Filters by workspace. Match: exact. Entities shared across the account - those with no owning workspace - are reachable from every workspace and are therefore returned as well, so the result can contain entities whose own workspaceId is empty. Only campaigns are assigned a workspace automatically, so for the other entity types shared entities are common. Workspace ids come from GET /startup.
Headers
If the requested variant has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.
Response
List of Affiliate Networks.