Skip to main content
GET
List scan history

Authorizations

Authorization
string
header
required

Partner API key as a Bearer token: Authorization: Bearer gsk_live_.... Live keys (gsk_live_) run real scans; test keys (gsk_test_) run request validation then return deterministic sandbox mocks (sandbox: true, nothing persisted, no rate-limit consumption). Keys are issued per partner and are revokable.

Query Parameters

limit
integer
default:50

Page size. Values above 200 are clamped to 200.

Required range: 1 <= x <= 200
cursor
string<date-time>

Opaque cursor from the previous page's next_cursor (a created_at timestamp). Returns scans created strictly before it.

from
string<date-time>

Window start (inclusive, ISO-8601 date or datetime). Defaults to 30 days ago. Pass an older date to list historical scans. Mutually exclusive with month (400 if combined).

to
string<date-time>

Window end (exclusive, ISO-8601 date or datetime). Defaults to now. Must be after from (400 otherwise). Mutually exclusive with month (400 if combined).

month
string

Calendar-month shorthand: expands to that UTC calendar month ([first-of-month, first-of-next-month)), overriding the default rolling 30-day window. Mutually exclusive with from/to — 400 if combined with either.

Pattern: ^\d{4}-(0[1-9]|1[0-2])$

Response

One page of scan history.

scans
object[]
required

Scan history, newest first.

next_cursor
string | null
required

created_at of the last item in this page; pass as ?cursor to fetch the next (older) page. Null when this is the last page.