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>'
{
  "configs": [
    {
      "id": "subcfg_01k8ap1btqf5r9fq2c8ax5fhc9",
      "name": "Marketing Campaign",
      "callback_url": "https://your-app.com/webhooks/subscription",
      "messages": {
        "help_message": "Reply STOP to unsubscribe or START to resubscribe.",
        "stop_message": "You have been unsubscribed and will not receive further messages. Reply START to resubscribe.",
        "start_message": "You have been resubscribed and will receive messages again. Reply STOP to unsubscribe."
      },
      "mo_phone_numbers": [
        {
          "country_code": "US",
          "phone_number": "+15551234567"
        },
        {
          "country_code": "FR",
          "phone_number": "36184"
        }
      ],
      "created_at": "2024-01-01T12:00:00Z",
      "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.

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.

Examples:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="