API ReferenceReports

List reports

Headers

x-api-keystringRequired
API key or token

Query parameters

user_idstring or nullOptionalformat: "uuid"
Valid UUID of the user to filter reports by
agency_idstring or nullOptionalformat: "uuid"
Valid UUID of the agency to filter reports by
event_occurred_afterdatetime or nullOptional

Filter reports where event occurred on or after this date/datetime (UTC)

event_occurred_beforedatetime or nullOptional

Filter reports where event occurred on or before this date/datetime (UTC)

report_created_afterdatetime or nullOptional

Filter reports created on or after this date/datetime (UTC)

report_created_beforedatetime or nullOptional

Filter reports created on or before this date/datetime (UTC)

report_updated_afterdatetime or nullOptional

Filter reports updated on or after this date/datetime (UTC)

report_updated_beforedatetime or nullOptional

Filter reports updated on or before this date/datetime (UTC)

report_statusenum or list of enums or nullOptional

Filter reports by status (single value or list)

user_emailstring or nullOptionalformat: "email"
Filter reports by user email
include_archivedbooleanOptionalDefaults to false
Whether to include archived reports
limitintegerOptional1-1000Defaults to 1000
Maximum number of reports to return
offsetintegerOptional>=0Defaults to 0
Number of reports to skip

Response

Successful Response
reportslist of objects
metadataobject

Errors

403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error