Skip to main content
List your company’s reports, with filters and pagination. Each row summarizes one report: its name, type, description, the reporting data table it is built on, 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

​
search
string
Filter matched against the report name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the report id.
​
report_type
string
Filter restricting results to statement or record reports. Omit to return both kinds. One of: statement, record.
​
limit
integer
Page size, between 1 and 250. Defaults to 50.
​
offset
integer
Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

​
Response

Body

​
reports
object[]
​
next_offset
integer