Sign in
Users

List Topics

Lists the authenticated user's topic-scoped notification preferences, plus user-agnostic platform defaults. Each filter matches preferences scoped to its value or not narrowed on that dimension. Per-experience levels are listed separately, by GET /users/me/preferences/notifications/experiences.

get/users/me/preferences/notifications/topics

Query parameters

channel'in_app' | 'mobile'

Only return preferences for this delivery channel (or not narrowed to a channel).

account_idstring

Only return preferences scoped to this account's member notifications (biz_ tag).

team_account_idstring

Only return preferences scoped to this account's team notifications (biz_ tag).

experience_idstring

Only return preferences scoped to this experience (exp_ tag).

topic_idstring

Only return preferences scoped to this notification topic (topic_ tag).

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

preferences listed

Example response

{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "unpf_xxxxxxxxxxxxxx",
      "level": "all",
      "object": "notification_preference",
      "scope": {
        "account_id": "biz_xxxxxxxxxxxxxx",
        "channel": "in_app",
        "experience_id": "exp_xxxxxxxxxxxxxx",
        "team_account_id": "biz_xxxxxxxxxxxxxx",
        "topic_id": "topic_xxxxxxxxxxxxxx"
      },
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 4 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

  • f1020c3ecda41See the full diff
    • ○

      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

  • bdd0e2c70d581See the full diff
    • ○

      the security scope user:notifications:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 16 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.