Skip to main content
GET
/
v2
/
notify
/
management
/
subscriptions
List subscription configurations
curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.prelude.dev/v2/notify/management/subscriptions"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/notify/management/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://api.prelude.dev/v2/notify/management/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://api.prelude.dev/v2/notify/management/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://api.prelude.dev/v2/notify/management/subscriptions")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/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
{
  "configs": [
    {
      "id": "<string>",
      "name": "<string>",
      "callback_url": "<string>",
      "messages": {
        "help_message": "<string>",
        "stop_message": "<string>",
        "start_message": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "mo_phone_numbers": [
        {
          "country_code": "US",
          "phone_number": "+15551234567"
        },
        {
          "country_code": "FR",
          "phone_number": "36184"
        }
      ]
    }
  ],
  "next_cursor": "<string>"
}
{
"code": "<string>",
"message": "<string>",
"type": "<string>",
"request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:50

Maximum number of configurations to return per page

Required range: 1 <= x <= 200
cursor
string

Pagination cursor from the previous response

Response

OK

configs
object[]
required

A list of subscription management configurations.

next_cursor
string

Pagination cursor for the next page of results. Omitted if there are no more pages.

Example:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="