Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-27"

Query Parameters

channel
enum<string>

Only return preferences for this delivery channel (or not narrowed to a channel).

Available options:
in_app,
mobile
account_id
string

Only return preferences scoped to this account's member notifications (biz_ tag).

team_account_id
string

Only return preferences scoped to this account's team notifications (biz_ tag).

experience_id
string

Only return preferences scoped to this experience (exp_ tag).

topic_id
string

Only return preferences scoped to this notification topic (topic_ tag).

first
integer

The number of preferences to return.

after
string

A cursor; returns preferences after this position.

Response

preferences listed

data
object[]
required
page_info
object
required