Get subscriptions

get

/api/v1/notifications/subscriptions

{basePath}/notifications/subscriptions

The API is used to get the current set of subscriptions to a subscriber.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

A collection of subscriptions
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array subscription items.
Show Source
Nested Schema : Subscription
Type: object
A Subscription
Show Source
Nested Schema : MessageType
Type: object
Information about the type of message.
Show Source
  • Identifier of the message type [Source - POS].
    Message type IDSupported hierarchy level subscriptions
    CheckNotificationSupports organization, property, and revenue center hierarchy level subscriptions.
    OrganizationsNotificationSupports organization, property, and revenue center hierarchy level subscriptions.
    ConfigurationNotificationSupports organization, property, and revenue center hierarchy level subscriptions.
    EmployeesNotificationSupports organization and property hierarchy level subscriptions.
Nested Schema : PostOfficeOptions
Type: object
Information about the PostOffice for the subscription
Show Source
  • Information about the PostOffice for the subscription Valid values are "PushOnePostOffice"

400 Response

400 Bad Request
Body ()
Root Schema : NotificationsApiProblemDetails
Type: object
Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`
Show Source
  • A human-readable explanation specific to this occurrence of the problem.
    Example: The OrgShortName value is required.
  • A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    Example: required_value_missing
  • A short, human-readable summary of the problem type.
    Example: Required value not specified.
  • A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".
    Example: error:validation
Example:
{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

401 Response

401 Unauthorized
Headers
  • Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.

    The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.

    No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer

    Expired token: The access token has expired. The timestamp in this example is illustrative.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"

    Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"

    Invalid signature: The token signature is invalid. For example, the token may have been modified.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"

    For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.

    The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.

404 Response

404 Requested resource not found
Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "items": [
    {
      "subscriptionId": "string",
      "callbackUri": "string",
      "messageType": {
        "id": "CheckNotification"
      },
      "postOfficeOptions": {
        "PostOfficeType": "string"
      },
      "orgShortName": "string",
      "locRef": "string",
      "rvcRef": "string"
    }
  ]
}
Back to Top