Help Page Home

GET api/notifications/subscriptions

Get all active subscriptions.

Required Scopes

System.Notifications

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of subscriptions.

Collection of Subscription
NameDescriptionTypeAdditional information
SubscriptionId

globally unique identifier

None.

TopicCode

string

None.

CreatedAt

date

None.

Push

SubscriptionPush

None.

Response Formats

[
  {
    "SubscriptionId": "0d0f18b9-f148-4f35-9242-80be6a000ea4",
    "TopicCode": "sample string 2",
    "CreatedAt": "2026-10-01T00:56:02.49446+01:00",
    "Push": {
      "URL": "sample string 1",
      "Format": "Uninitialised",
      "AuthEnabled": true,
      "AuthScheme": "sample string 3",
      "AuthParameter": "sample string 4"
    }
  },
  {
    "SubscriptionId": "0d0f18b9-f148-4f35-9242-80be6a000ea4",
    "TopicCode": "sample string 2",
    "CreatedAt": "2026-10-01T00:56:02.49446+01:00",
    "Push": {
      "URL": "sample string 1",
      "Format": "Uninitialised",
      "AuthEnabled": true,
      "AuthScheme": "sample string 3",
      "AuthParameter": "sample string 4"
    }
  }
]
<ArrayOfSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AudaAPI.Models.Notification">
  <Subscription>
    <CreatedAt>2026-10-01T00:56:02.49446+01:00</CreatedAt>
    <Push>
      <AuthEnabled>true</AuthEnabled>
      <AuthParameter>sample string 4</AuthParameter>
      <AuthScheme>sample string 3</AuthScheme>
      <Format>Uninitialised</Format>
      <URL>sample string 1</URL>
    </Push>
    <SubscriptionId>0d0f18b9-f148-4f35-9242-80be6a000ea4</SubscriptionId>
    <TopicCode>sample string 2</TopicCode>
  </Subscription>
  <Subscription>
    <CreatedAt>2026-10-01T00:56:02.49446+01:00</CreatedAt>
    <Push>
      <AuthEnabled>true</AuthEnabled>
      <AuthParameter>sample string 4</AuthParameter>
      <AuthScheme>sample string 3</AuthScheme>
      <Format>Uninitialised</Format>
      <URL>sample string 1</URL>
    </Push>
    <SubscriptionId>0d0f18b9-f148-4f35-9242-80be6a000ea4</SubscriptionId>
    <TopicCode>sample string 2</TopicCode>
  </Subscription>
</ArrayOfSubscription>