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

url = "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers"

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/{config_id}/phone_numbers', 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/{config_id}/phone_numbers",
  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/{config_id}/phone_numbers"

	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/{config_id}/phone_numbers")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers")

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
{
  "phone_numbers": [
    {
      "config_id": "<string>",
      "phone_number": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  ],
  "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.

Path Parameters

​
config_id
string
required

The subscription configuration ID

Query Parameters

​
state
enum<string>

Filter by subscription state

Available options:
SUB,
UNSUB
​
limit
integer
default:50

Maximum number of phone numbers to return per page

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

Pagination cursor from the previous response

Response

OK

​
phone_numbers
object[]
required

A list of phone numbers and their subscription statuses.

​
next_cursor
string

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

Example:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="