Skip to main content
List your company’s reports, with filters and pagination. Each row summarizes one report: its name, type, description, the tracked data table for record reports, and the section it is filed under. Callers with write access on reports also get who can view each report (access — the roles, including roles with default access such as admins, and the users it is shared with); read-only callers get access: null. A report’s internals — fields, filters, pivot-table and chart configuration — are intentionally not returned. You only see the reports you have access to; the rest are omitted. Rows are ordered alphabetically by report name (A→Z).

​
Parameters

Body

​
string
Filter matched against the report name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the report id.
​
string
Filter restricting results to statement or record reports. Omit to return both kinds. One of: statement, record.
​
string
Id of the sandbox to read instead of the live environment — the id list_sandboxes returns. Omit it to read the live environment, the company’s real compensation data, which is the right choice unless the question is explicitly about a sandbox. Only a sandbox id is accepted here — never a sandbox name, and never the live environment’s own id.
​
integer
Page size, between 1 and 250. Defaults to 50.
​
integer
Row offset into the result set — the number of rows to skip before this page. Any offset >= 0 is accepted; it does not have to be a multiple of limit, so you can start from an arbitrary row. Pass the next_offset returned by the previous call to walk the pages, or None for the first page.

​
Response

Body

​
object[]
​
integer