Frihet icon

Frihet

AI-native ERP — invoices, expenses, clients, products, quotes, and vendors

Actions33

Client → List

AI-generated

Summary

List clients with optional pagination and filters

Inputs

  • returnAll — Whether to return all matching records or stop at the specified limit
  • limit — Maximum number of results to return when returnAll is false
  • after — Pagination cursor to start from; use the nextCursor value from a previous response
  • filters — Collection of filter criteria such as status, date ranges, search query, or client ID

Output shape

an array of client objects (or a page of results wrapped with meta information)

Results are paginated; when returnAll is false only one page is returned and may be wrapped with meta including nextCursor. The shape may include an empty array if no matches.

Examples

Example 1: Retrieve the first 10 clients filtered by status 'sent'

resource=Client, operation=list, limit=10, filters={"status":"sent"}

Example 2: Fetch all clients using pagination

resource=Client, operation=list, returnAll=true

Example 3: Search clients by name using a query string

resource=Client, operation=list, filters={"q":"Acme"}

Links

Discussion