Sign in
latestOpenAPI 3.1.02026-08-163864115.7 MB

c363cb2feb95

Notifications

List Notification Topics

Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are internal and not returned.

get/notifications/topics

Query parameters

topic_type'user' | 'account_team'

Only return topics of this scope: user (member notifications) or account_team (team notifications).

firstinteger

The number of topics to return (default 20, max 100).

afterstring

A cursor; returns topics after this position.

Response

notification topics listed

Example response

{
  "data": [
    {
      "description": "A customer books and pays for a detail",
      "id": "topic_xxxxxxxxxxxxxx",
      "identifier": "notification_topic1_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "is_mention": true,
      "name": "New sales",
      "topic_type": "account_team"
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}