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:

  • mine: eq(mine,true) lists only the briefings sent to the caller. No other term on mine is accepted.
  • organisation: Filter by the organisation that owns the briefing.
  • recipient_organisation: Filter by an organisation the briefing reached, e.g. or(eq(organisation,X),eq(recipient_organisation,X)) for everything organisation X can see.
  • status: Filter by the briefing's status: draft, sent or archived, e.g. in(status,[sent,archived]).
  • source: Filter by where the briefing came from: v3, or v2 for one migrated from a v2 bulletin.

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:
created_at,
-created_at,
updated_at,
-updated_at,
sent_at,
-sent_at,
title,
-title,
status,
-status,
acknowledge_by,
-acknowledge_by

Response

A list of briefings

JSON API response object

data
A list of briefings · object[]
required
meta
object
required
jsonapi
object
required