Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
page
object

JSON:API pagination, as page[limit] and page[offset]. The same as the top-level limit and offset parameters; when both forms are sent, page[...] wins.

filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • briefing: Filter by briefing ID, for one briefing's gap view.
  • user: Filter by the recipient's user ID, for a member's briefing history.
  • organisation: Filter by the recipient's organisation ID, e.g. one contractor.
  • briefing_organisation: Filter by the organisation that sent the briefing, e.g. or(eq(briefing_organisation,X),eq(organisation,X)) for everything organisation X can see.
  • job_role: Filter by a job role that matched the recipient.
  • state: Filter by the recipient's progress: sent, viewed or acknowledged. in(state,[sent,viewed]) is every recipient who has not acknowledged.
  • briefing_status: Filter by the briefing's status, sent or archived. eq(briefing_status,sent) leaves out archived briefings.
  • acknowledge_by: Filter by the briefing's acknowledge-by date, e.g. lt(acknowledge_by,2026-11-09T00:00:00Z) with in(state,[sent,viewed]) for overdue recipients.

For more information on using named filters, see the docs

sort
enum<string>[]

A comma separated list of fields to sort by. A - prefix sorts descending. Any other field is refused.

Available options:
sent_at,
-sent_at,
viewed_at,
-viewed_at,
acknowledged_at,
-acknowledged_at,
acknowledge_by,
-acknowledge_by,
state,
-state,
briefing_title,
-briefing_title

Response

A list of briefing recipients

JSON API response object

data
A list of briefing recipients · object[]
required
meta
object
required
jsonapi
object
required