Skip to main content
GET
List reports
List the reports in a deployment, scoped to the reports the calling user can access. Results are returned in pages using cursor-based pagination: pass first to set the page size and after (the previous response’s pageInfo.endCursor) to fetch the next page. Cursor pagination is not supported when sorting by lastViewedAt (a per-viewer sort with no stable cursor column).

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
number
required

Query Parameters

workbookId
integer | null
folderId
integer | null
externalWorkbookId
string | null
search
string | null
limit
integer | null
page
integer | null
sortBy
enum<string> | null
Available options:
name,
createdAt,
updatedAt,
lastViewedAt
sortDirection
enum<string> | null
Available options:
ASC,
DESC
after
string
first
integer
Required range: x >= 1

Response

200 - application/json
data
object[]
required
deprecated

Deprecated: use items instead. Kept for backward compatibility.

items
object[]
required
count
integer | null
deprecated

Deprecated: total number of accessible reports, ignoring pagination. Kept for backward compatibility.

Required range: x >= 0
pageInfo
object | null