Skip to content

Client.reports

Reports in the default project (requires set_team; set_project for listing).

list(project), get, create, team/trash lists and backlinks do not require set_project. Bracket listing uses the default project.

Signature

@property
reports -> ReportCollection

HTTP parameters

Name In Type Required Default
limit query integer no 50
offset query integer no 0
ordering query string no -
project_id query string yes -
q query string no -

Return shape

HTTP 200 — OK

array<ReportListOut>

Permission

Required permission: report:read

HTTP

GET /api/reports/ (listReports)

Usage

client.reports