v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Notification Subscriptions

Retrieve a Registration Provider Notification Subscription

Retrieve the details of a specific notification subscription associated with a registration provider. This endpoint allows an authenticated user to view their current subscription preferences for events related to a specific registration provider.

Permissions

  • The requesting user must be authenticated.
  • The requesting user must be the owner of the subscription.

Unauthorized or forbidden access attempts will result in 401 Unauthorized or 403 Forbidden errors.

Returns A JSON object representing the notification subscription, including:

  • id: Unique identifier of the subscription.
  • type: Resource type (always subscription).
  • attributes: Event type and notification frequency.
  • relationships: Links to the associated user and provider resources.
  • links: A self link to this subscription resource.
get/providers/registrations/{provider_id}/subscriptions/{subscription_id}/

Path parameters

provider_idstring required

The unique identifier of the registration provider associated with this subscription.

subscription_idstring required

The unique identifier of the notification subscription.

Response

Subscription successfully retrieved.