Get a Subscription
Use this endpoint to retrieve information about an existing subscription. A successful response returns the subscription name, callback URL, batch size, status of the subscription, and the event types associated with the subscription.
Service URL:
/rest/api/v1.3/notifications/subscriptions/{subscriptionName}
Path Parameters:
subscriptionName – Name of the subscription to retrieve.
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"subscriptionName": "<subscription_name>",
"callBackUrl": "<callback_url>",
"callBackName": "<callback_name>",
"batchSize": 2,
"eventTypes": [
"EMAIL_BOUNCED"
],
"status": "ACTIVE"
"filters": [
{
"eventTypes": [
"EMAIL_FAILED"
],
"values": [
{
"campaignNames": [
"vk_campaign_failed"
]
}
]
}
]
}
Sample Response Body - Failure
404 Not Found
Subscription not available: Requests fail if the subscription is not found. Verify the subscription exists. The error resembles:
{
"type": "",
"title": "Object not found",
"errorCode": "OBJECT_NOT_FOUND",
"detail": "Subscription with name [<subscription_name>] not found",
"errorDetails": [ ]
}