v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Notification Subscriptions

Retrieve a List of Notification Subscriptions

Retrieve a paginated list of the authenticated user's notification subscriptions. Each subscription describes the user's preferences for receiving notifications about specific events on OSF resources such as projects, preprints, registrations, or collections.

Permissions

  • The authenticated user can only retrieve their own subscriptions. - Authentication is required.

Returns

  • A JSON object containing a data array of subscription resources, each representing a single subscription. - Each subscription includes details such as the event_name, frequency, and links to related resources. - The response also includes links and meta keys for pagination support.
get/subscriptions/

Query parameters

pageinteger

The page number of the paginated result set.

filter[event_name]string

Filter subscriptions by event_name.

Response

Successful retrieval of the user's notification subscriptions.