Skip to main content
GET
Get Results

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

The brand's UUID from listBrands.

Query Parameters

limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
order
enum<string>
default:label

label orders Paying off, Cited, then Delivered; newest orders by result date.

Available options:
label,
newest

Response

Successful Response

counts
Counts · object
required

All delivered actions by result label, independent of order and page.

limit
integer
required

The requested maximum rows per page.

meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required

Rows skipped before this page.

rows
ResultRow · object[]
required

One page of delivered actions and their results.

total
integer
required

All delivered actions before paging.