Skip to main content
GET
TypeScript

Autorisations

Authorization
string
header
requis

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

user:notifications:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de requête

channel
enum<string>

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

Options disponibles:
in_app,
mobile
account_id
string

Only return preferences scoped to this account's member notifications (biz_ tag), or not narrowed to an account.

team_account_id
string

Only return preferences scoped to this account's team notifications (biz_ tag), or not narrowed to a team account.

experience_id
string

Only return preferences scoped to this experience (exp_ tag), or not narrowed to an experience.

topic_id
string

Only return preferences scoped to this notification topic (topic_ tag), or not narrowed to a topic.

first
integer
défaut:20

Number of results to return from the start of the range.

Plage requise: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Réponse

preferences listed

data
object[]
requis
page_info
object
requis