Skip to main content
GET
Get Weekly Brief

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
with_today
boolean
default:false

Include the viewer's live Today box alongside the issued brief.

Response

Successful Response

decisions
Decision · object[]
required

A page of the reader's fixed decision set.

done
boolean
required

Every decision in the issued set is answered or no longer applies.

issued_at
string<date-time> | null
required

When this fixed decision set issued.

limit
integer
required

Maximum rows returned from each decision list.

meta
Meta · object
required

Normalized query and newest included scan.

new_since_monday
Decision · object[]
required

A separate page of member turns and suggestions arriving after issue.

new_total
integer
required

Current decisions that arrived after issue in this reader's scope.

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 in each decision list.

remaining
integer
required

Unanswered decisions in that fixed set, excluding later arrivals.

scan_id
string<uuid> | null
required

The report this brief issued with; null before issue.

today
HomeToday · object | null
required

The viewer's live Today box.

total
integer
required

Issued decisions in this reader's fixed set.