Skip to main content

List Custom Reports

GET 
/api/v2/custom-reports

List the saved reports you can see: reports you own, reports shared with you, and reports with shared visibility. Newest-updated first.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query:

  • page (default 1), per_page (default 20)
  • search: report name contains (matched literally)
  • domain: exact domain (e.g. sales, inventory, sql)
  • tab: my_reports (owned, non-template), shared (shared visibility or shared with you), templates, favorites (your favorited reports)

Response: standard pagination (data, current_page, last_page, per_page, total, ...). Each item is a custom report including user_name (the owner).

Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type