List Subscriptions

GET https://{{axpAPIDomain}}/api/notification/v1/accounts/:accountId/subscriptions?pageNumber=1&pageSize=10

Return a list of existing notification subscriptions

Request Params

KeyDatatypeRequiredDescription
pageNumbernumberThe page number of the records to retrieve. Default value is 1
pageSizenumberThe max number of records to retrieve per page. Default value is 10, max value is 25.

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":20,"total":60},"subscriptions":[{"subscriptionId":"fdbec917-e76e-4645-8120-4eac46f29487","createdAt":"2020-08-01T14:25:23.162Z","expiresAt":"2020-08-08T14:25:23.177Z","expiresIn":900,"status":"ACTIVE","family":"AGENT_ENGAGEMENT","events":["ALL"],"transport":{"type":"WEBHOOK","endpoint":"https://webhook.site/ccc61bd0-a607-4ba0-b891-a9d7484d6196","authToken":"eyJ0eXAiOiJKV1QiLCJub25jZSI6Ildp...","authTokenHeader":"my-custom-header"}}],"links":{"prev":"https://example.avayacloud.com/api/notification/v1/accounts/JDBUTC/subscriptions?pageNumber=1\u0026pageSize=20","next":"https://example.avayacloud.com/api/notification/v1/accounts/JDBUTC/subscriptions?pageNumber=3\u0026pageSize=20"}}