Sign in
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

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

afterstring

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

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": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 3 of the 74 revisions of this API.113

  • ff3a7657356311See the full diff
    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

  • f1020c3ecda42See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be4221See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.