Get notification subscriptions

Retrieve the authenticated user’s notification configuration, available channels, current selections, and user context. The {user} path accepts the authenticated user’s numeric ID or me.

GET /notifications/{user}/subscriptions

Get notification subscriptions

cURL

curl --request GET \
  --url https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "available_channels": [
    "email",
    "in_app",
    "mobile"
  ],
  "subscriptions": [
    {
      "group_name": "Messages",
      "group_description": "Notifications about direct activity",
      "requires": "artist",
      "subscriptions": [
        {
          "name": "Direct Messages",
          "notif_id": "new_message",
          "description": "When you receive a direct message",
          "requires": "artist"
        }
      ]
    }
  ],
  "user_selections": [
    {
      "id": 1,
      "name": "Direct Messages",
      "notif_id": "new_message",
      "description": "When you receive a direct message",
      "requires": "artist",
      "channels": {
        "email": true,
        "in_app": true,
        "mobile": true
      }
    }
  ],
  "user_context": {
    "is_artist": true,
    "is_verified_artist": true
  }
}

Authorizations

Authorization · string · header · required

API access is invite-only. Contact [e-mail] to request access. Once approved, generate tokens from Account Settings → Developers. Include as: Authorization: Bearer {token}. Tokens expire after 90 days.

Path Parameters

user · string · required

Authenticated user ID or me.

Example:

"me"

Response

200

application/json

Notification configuration and current selections

status · string

Example:

"success"

available_channels · string[]

Example:

["email", "in_app", "mobile"]

subscriptions · object[]

Notification preference groups and available notification types.

Show child attributes

user_selections · object[]

Show child attributes

user_context · object

Show child attributes