Matchai Docs

Get notification preferencesComing soon

Returns which channels and topics the account is notified about.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/notifications/preferences

Coming soon. Returns which channels and topics the account is notified about.

Scopes: notifications:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: notifications:read

Response Body

Preferences.

application/json
  1. response
channels*
topics*
Example Request
curl -X GET 'https://api.matchai.co/v1/notifications/preferences'
Example Response
{  "channels": {    "push": true,    "email": true,    "text": true  },  "topics": {    "new_message": true,    "appointment_request": true,    "appointment_reminder": true,    "listing_update": true,    "contact_activity": true  }}