Actions33
Vendor → List
AI-generatedSummary
List vendors with optional pagination, limits, and filters.
Inputs
- returnAll — Whether to return all results or only up to a given limit.
- limit — Maximum number of results to return (1‑100).
- after — Pagination cursor to start after; use the nextCursor from a previous response.
- filters — Collection of filter criteria such as status, from, to, q, clientId, etc.
Output shape
An array of vendor objects. When not using returnAll and no items are found, the array contains a single object with items (empty array) and meta (pagination metadata).
If
returnAllis true the endpoint paginates until all results are gathered; otherwise only one page is returned. Pagination cursor is exposed via thenextCursormeta field in the response.
Examples
Example 1: Retrieve the first 20 vendors with status active
Return All: false, Limit: 20, Filters: {"status":"active"}
Example 2: Fetch all vendors matching a search query
Return All: true, Filters: {"q":"Acme"}