Skip to main content
GET
List screening history

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Query Parameters

offset
string

Number of records to skip. Defaults to 0.

limit
string

Page size, 1-100 inclusive. Defaults to 10.

address
string

Return only screens requested for this address. metadata.total reflects the filtered count. The value is normalised exactly as GET /v2/risk/address normalises it, so equivalent forms of the same address match the same records — note this can change the address by more than case (EVM addresses are lowercased; a Stellar muxed M… account folds to its base G… account), and the records returned echo the normalised form. Passing the parameter with an empty value is a client error, not an unfiltered request.

sort
enum<string>

Page ordering. newest (default) is the assessment timestamp descending — the field returned on each item. severity orders worst-first, by severity rank rather than alphabetically, with newest as the tiebreak within a band; a screen with no recorded severity ranks alongside none, at the bottom. Both orders carry an internal tiebreak so paging is deterministic. metadata.applied_sort echoes the order used. An unrecognised value is a client error rather than a silent fallback to the default.

Available options:
newest,
severity
from
string

Only return screens queried at or after this ISO 8601 date-time (inclusive). A bare date (2026-05-01) or a date-time with no Z/offset (2026-05-01T00:00:00) is interpreted as UTC, not the server's local time; a value carrying Z or an explicit offset is honoured as given. metadata.filtered_from echoes the applied bound. An unparseable value is a client error, not an unfiltered request.

to
string

Only return screens queried at or before this ISO 8601 date-time (inclusive). Parsed as UTC the same way as from, except a bare date (2026-05-31) expands to the inclusive end of that UTC day (23:59:59.999Z) rather than its start. metadata.filtered_to echoes the applied bound. An unparseable value is a client error, not an unfiltered request.

include_failed
string

When true (or 1), also include screens that failed (success: false) and set success on every item in the response. Defaults to false, which is this endpoint's original behaviour: only successful screens, and no success field on items. A failed item always reports severity: 'none' (no assessment ran), so combining this with ?severity= excludes every failed screen — metadata->>'severity' is NULL for those rows, not 'none', and the severity filter only matches recorded values.

severity
enum<string>[]

Return only screens whose overall severity is one of these. Comma-separated for more than one (severity=high,severe) or repeated (severity=high&severity=severe), case-insensitive, and duplicates are collapsed. This is set membership, not a threshold — severity=high returns high and nothing else, so a caller after "everything that needs review" must name each severity it wants (severity=severe,high). metadata.total reflects the filtered count and metadata.filtered_severity echoes the applied set. An unrecognised value is a client error, as is passing the parameter with an empty value — neither is treated as an unfiltered request. Note that a stored screen with no recorded severity matches no value at all, so the filter is not a partition of the workspace's history.

Available options:
severe,
high,
medium,
low,
none

Response

200 - application/json
items
object[]
required
metadata
object
required
Last modified on November 9, 2026