Skip to main content
GET
List reports
string
Unique identifier of the report
string
Unique identifier of the account associated with the report
enum
Status of the report
enum
Type of the report
string
string
string
string
string

Allowed filter combinations

  • id
  • account_id
  • account_id, status
  • account_id, status, type
  • report_template_id
  • report_template_id, status
  • account_id, report_template_id, status
Fields that can be searched on using _search query param
string
Search by Unique identifier of the reports
string
Search by name of the reports
string
Search by file id of the reports
string
Search by account id of the reports
string
Search by report template id of the reports
Fields with which the list response can be sorted using _sort query param
string
string
string
Default sort order:id DESC
Downloading Reports:Reports can be downloaded using the fileId parameter of the Report entity using the Files API.
Sharing Reports:Sharable links can be generated using the Generate download URL API which are S3 signed URLs valid for 1 hour and do not require authentication.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

nextToken
string
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize
number
Example:

10

fetchFor
enum<string>
default:ORGANIZATION

Fetch for flag used to get the reports from:

  1. ALL: Both the organization and accounts
  2. ORGANIZATION: Only the organization
  3. ACCOUNTS: Only accounts, works with account_id filter only.
Available options:
ALL,
ORGANIZATION,
ACCOUNTS

Response

Response for List Report requests

Represents a list response for reports

data
object[]
nextToken
string