Skip to main content
This endpoint returns your master preference and the preference for each notification type. See Preferences for how they work together.

Operation Type (for Signing)

Request Body

FieldTypeNeedDescriptionExample
”account”stringrequiredUser’s wallet address42trU9A5…
“signature”stringrequiredCryptographic signature5j1Vy9Uq…
“timestamp”integerrequiredCurrent timestamp in milliseconds1716200000000
”expiry_window”integeroptionalSignature expiry in milliseconds30000
”agent_wallet”stringoptionalAgent wallet address69trU9A5…
You can sign this request with the account key or with an agent wallet.

Signing

This request has no fields of its own. Sign an empty data object:

Response

  • Status 200: Successfully retrieved notification preferences
FieldTypeDescription
”master_enabled_channels”arrayChannels that are on in the master preference:
“in_app"
"mobile_push"
"web_push"
"preferences”arrayOne entry for each notification type that you can configure
”notification_type”stringNotification type
”enabled_channels”arrayChannels that are on for this type
preferences always lists all eight types, in the order above. A type that you never set has an empty enabled_channels list. A new account has empty lists everywhere.
  • Status 400: Invalid request parameters or signature
  • Status 403: The account doesn’t exist. An account exists after its first deposit
  • Status 429: Rate limit exceeded
  • Status 500: Internal server error

Code Example (Python)