Matchai Docs

List notificationsComing soon

Returns the account’s notifications, newest first.

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

Coming soon. Returns the account’s notifications, newest first.

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

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
unread?boolean

Only unread notifications.

category?string

Only this category.

Value in"critical_action""approval_request""essential_business""user_engagement""workflow_update""system_maintenance"

Response Body

One page of notifications.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/notifications'
Example Response
{  "data": [    {      "id": "string",      "title": "string",      "message": "string",      "category": "critical_action",      "priority": "critical",      "read": true,      "read_at": "2019-08-24T14:15:22Z",      "subject": {        "type": "listing",        "id": "string"      },      "action": {        "label": "string",        "url": "http://example.com"      },      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}