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>'

import requests

url = "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://open.beatpass.ca/api/v1/notifications/{user}/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "available_channels": [
    "email",
    "in_app",
    "mobile"
  ],
  "subscriptions": [
    {
      "group_name": "Messages",
      "group_description": "Notifications about direct activity",
      "subscriptions": [
        {
          "name": "Direct Messages",
          "notif_id": "new_message",
          "description": "When you receive a direct message"
        }
      ]
    }
  ],
  "user_selections": [
    {
      "id": 1,
      "name": "Direct Messages",
      "notif_id": "new_message",
      "description": "When you receive a direct message",
      "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