List event subscriptions

GET

/subscriptions

Last modified:2026-10-08 23:02:56

OperationId:ReadSubscriptions

Returns the event subscriptions your token can see. Each one sends events of one model to its post-url.

Requires Basic User, Site Manager, Office Manager, Reseller, Super User, or Super User Read Only. Super User and Super User Read Only see every subscription. A Reseller sees the subscriptions in its own territory, except the ones a Super User created, and can narrow to one of its domains. Every other scope sees the subscriptions its own scope created in its own domain, and user-level scopes see only their own and domain-wide ones. Naming a domain you cannot see returns 403.

post-url comes back in full only when you can change the subscription. Otherwise its user-info, query string, and fragment are masked.

Filter with domain, user, and, for a Super User or Super User Read Only, reseller and user-scope. Page with start and limit, 100 subscriptions by default. There is no sort and no /count. GET /subscriptions/list returns fewer fields per subscription.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

The subscriptions you can see, possibly an empty array.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/subscriptions?domain=example.com&user=1001&reseller=example-reseller&start=undefined&limit=undefined&user-scope=Reseller' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Two subscriptions

A domain-wide call subscription and a cdr subscription for one user that is failing.

[
    {
        "id": "9f86d081884c7d659a2feaa0c55ad015",
        "model": "call",
        "post-url": "https://webhook.example.com/events",
        "subscription-geo-support": "yes",
        "user-scope": "Reseller",
        "reseller": "example-reseller",
        "domain": "example.com",
        "user": "*",
        "subscription-creation-datetime": "2026-09-01T14:30:00+00:00",
        "subscription-expires-datetime": "2027-09-01T14:30:00+00:00",
        "preferred-server": "core1.example.com",
        "current-active-server": "core1.example.com",
        "status": "active",
        "error-count": 0,
        "posts-count": 1520
    },
    {
        "id": "4e07408562bedb8b60ce05c1decfe3ad",
        "model": "cdr",
        "post-url": "https://webhook.example.com/cdrs",
        "subscription-geo-support": "yes",
        "user-scope": "Reseller",
        "reseller": "example-reseller",
        "domain": "example.com",
        "user": "1001",
        "subscription-creation-datetime": "2026-09-01T14:30:00+00:00",
        "subscription-expires-datetime": "2027-09-01T14:30:00+00:00",
        "preferred-server": "core1.example.com",
        "current-active-server": "core2.example.com",
        "status": "error",
        "error-count": 3,
        "posts-count": 88
    }
]

Modified at 2026-10-08 23:02:56

Delete device profile

List domain event subscriptions