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>'
{
  "phone_numbers": [
    {
      "config_id": "subcfg_01k8ap1btqf5r9fq2c8ax5fhc9",
      "phone_number": "+33612345678",
      "state": "SUB",
      "source": "MO_KEYWORD",
      "reason": "STOP",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ],
  "next_cursor": "eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="
}

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.

Examples:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="