List subscription phone number events

GET

notify

management

subscriptions

{config_id}

phone_numbers

{phone_number}

events

List subscription phone number events

curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events \
  --header 'Authorization: Bearer <token>'

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

phone_number

string

required

The phone number in E.164 format (e.g., +33612345678)

Query Parameters

limit

integer

default:50

Maximum number of events to return per page

Required range: 1 <= x <= 200

cursor

string

Pagination cursor from the previous response

Response

events

object[]

required

A list of subscription events (status changes) ordered by timestamp descending.

Show child attributes

next_cursor

string

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

Example:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="

Get subscription phone number statusRetrieve the current subscription status for a specific phone number within a subscription configuration.

List subscription phone number events

curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events \
  --header 'Authorization: Bearer <token>'

{
  "events": [
    {
      "config_id": "<string>",
      "phone_number": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response