Reporter icon

Reporter

Interact with Reporter API

Actions120

Client → List clients

AI-generated

Summary

Lists Reporter clients using the configured filters, sorting, related-resource includes, and pagination. Enable Fetch All Pages to retrieve every result page; otherwise, request a specific page and page size.

Inputs

  • Additional Fields: Filter fields — Add field/value pairs to filter the client list.
  • Additional Fields: Sort — Add sort fields and choose ascending or descending order. Available fields are ID, name, website, created at, and updated at; direction defaults to ascending.
  • Additional Fields: Include — Comma-separated related resources to include; nested relations are supported.
  • Fetch All Pages — Defaults to false. When enabled, automatically fetches all pages while applying filters and sorting.
  • Page Size — Results per page when Fetch All Pages is disabled; defaults to 30 and allows values from 1 to 100.
  • Page Number — Page to retrieve when Fetch All Pages is disabled; defaults to 1.

Output shape

A list of client records

With Fetch All Pages enabled, the results span all fetched pages; otherwise they cover only the selected page. The provided source shows list request and pagination handling but does not expose the response envelope.

Links

Discussion