Skip to content
Disclose Bot

List all Reports that the auth token can access

GET
/v1/reports
 
curl --request GET \
  --url http://api.disclosebot.localdev:3000/v1/reports \
  --header 'Authorization: Bearer <token>'

Reports within the plan’s report history window (30 days on Free, unlimited on paid plans). meta.archived_count is the number of older reports kept beyond the window; upgrading lists them again.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q[title_cont]
string

Title contains; any ransack predicate over title, description, submitted_through_id (the brief: q[submitted_through_id_in][]=), created_at, encrypted, inbox_state, processing_state

results[severity][eq]
string

A result condition: results[][]= for any result key (severity, validity, scope, duplicate, summary, or a key an integration wrote) with predicate eq, not_eq, cont, not_cont, gteq, or lteq

q[submitted_through_id_in][]
string

Reports of these briefs (repeat for several); q[submitted_through_id_not_in][] for every other brief

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

Media type application/json
object
data
required
Array<object>
object
id
required
string
type
required
string
Allowed values: report
attributes
required
object
title
required
string
description
required
string
shortcode
required
string
inbox_state
required
string
processing_state
required
string
processed_at

When the last triage step completed

string format: date-time
nullable
discarded_at

When a Self Destruct brief’s report was purged, once every channel that took it had completed; null otherwise, including while a channel’s processing has failed

string format: date-time
nullable
results
required

Current results by key

object
key
additional properties
object
value
required
reason
string
nullable
source
required
string
Allowed values: triage integration api
written_at
required
string format: date-time
created_at
required
string
updated_at
required
string
relationships
object
organization
object
data
object
id
required
string
type
required
string
Allowed values: organization
brief
object
data
object
id
required
string
type
required
string
Allowed values: brief
meta
object
pagination
object
current
required
integer
first
integer
prev
integer
next
integer
last
integer
records
required

The unpaginated total

integer
archived_count

Reports outside the plan history window

integer
Example 
{
  "data": [
    {
      "type": "report",
      "attributes": {
        "results": {
          "additionalProperty": {
            "source": "triage"
          }
        }
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organization"
          }
        },
        "brief": {
          "data": {
            "type": "brief"
          }
        }
      }
    }
  ]
}