OSF

OSF Notification Subscriptions API

**Notification Subscriptions** allow users to manage how they receive alerts about activities and events related to OSF resources, such as projects, preprints, registrations, and collections. Subscriptions control **when** notifications are sent and **which events** trigger them. These subscriptions are **private** and are only visible to the authenticated user who owns them. ### Subscription Scope and Types Subscriptions can be configured at different scopes depending on the resource type: - **Global Subscriptions** Apply OSF-wide, affecting events like comment replies, mentions, and review updates across all resources. - **Node Subscriptions** Apply to individual projects or components (nodes), tracking events such as new comments or file updates. - **Provider Subscriptions** Apply to resources within a specific provider (collection, preprint, or registration providers). These subscriptions typically track events relevant to moderation workflows, such as new pending submissions. ### Attributes - `event_name` The specific event that triggers this subscription. Available event names depend on the scope of the subscription. Examples include: - `comments` - `file_updated` - `global_mentions` - `new_pending_submissions` - `frequency` Determines how often the user receives notifications for the event: - `instant`: Sends an email notification immediately after the event occurs. - `daily`: Groups event notifications into a daily summary email. - `none`: Disables notifications for the event. Users can update their notification frequency for each subscription. ### Relationships - `user` The user who owns the subscription. Each subscription is tied to a single user. - `provider` The provider associated with the subscription, if applicable. This may be a Collection Provider, Preprint Provider, or Registration Provider. Global subscriptions do not have a provider relationship. ### Available Event Names by Subscription Scope #### Node-Level Subscriptions Subscriptions specific to individual projects or components: - `comments`: Notify when comments are added. - `file_updated`: Notify when files are updated. #### Global Subscriptions Default notification preferences applied OSF-wide: - `global_comment_replies`: Notify when someone replies to your comments. - `global_comments`: Notify when comments are added to your projects. - `global_file_updated`: Notify when files are updated in your projects. - `global_mentions`: Notify when you are mentioned. - `global_reviews`: Notify when your preprint submissions are updated. #### Provider-Level Subscriptions Notifications related to moderation workflows or submissions within a specific provider: - `new_pending_submissions`: Notify when new preprint submissions are awaiting moderation. ### Notification Channels Notifications are delivered via **email**, according to the selected `frequency`: - `instant`: Immediate email notifications per event. - `daily`: Batched email summary delivered daily. - `none`: No email notifications are sent. ### Permissions and Access - Only the authenticated user who owns a subscription can view or update it. - Subscriptions are managed via the OSF API and reflect the user's current notification preferences for supported events.

GitHub OpenAPI

Operations 16

GET /subscriptions/ Retrieve a List of Notification Subscriptions #
GET /subscriptions/{subscription_id}/ Retrieve a Notification Subscription #
PATCH /subscriptions/{subscription_id}/ Update a Notification Subscription #
GET /providers/collections/{provider_id}/subscriptions/ List Notification Subscriptions for a Collection Provider #
GET /providers/collections/{provider_id}/subscriptions/{subscription_id}/ Retrieve a Collection Provider Notification Subscription #
PATCH /providers/collections/{provider_id}/subscriptions/{subscription_id}/ Update a Collection Provider Notification Subscription #
GET /providers/preprints/{provider_id}/subscriptions/ List Preprint Provider Subscriptions #
GET /providers/preprints/{provider_id}/subscriptions/{subscription_id}/ Retrieve a Preprint Provider Subscription #
PATCH /providers/preprints/{provider_id}/subscriptions/{subscription_id}/ Update a Preprint Provider Subscription #
GET /providers/registrations/{provider_id}/subscriptions/ List Registration Provider Subscriptions #
GET /providers/registrations/{provider_id}/subscriptions/{subscription_id}/ Retrieve a Registration Provider Notification Subscription #
PATCH /providers/registrations/{provider_id}/subscriptions/{subscription_id}/ Update a Registration Provider Notification Subscription #
GET /registration_subscriptions/{subscription_id}/ Retrieve a Registration Provider Subscription #
PATCH /registration_subscriptions/{subscription_id}/ Update a Registration Provider Subscription #
GET /collection_subscriptions/{subscription_id}/ Retrieve a Collection Subscription #
PATCH /collection_subscriptions/{subscription_id}/ Update a Collection Subscription #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/osf/openapi/osf-notification-subscriptions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osf:osf-notification-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osf-notification-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Notification Subscriptions API
  description: This is the official documentation for the OSF (Open Science Framework) API v2.
  version: '2.0'
  termsOfService: https://osf.io/terms_of_use/
  contact:
    name: OSF Support Team
    email: support@osf.io
    url: https://help.osf.io/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://cdn.cos.io/media/images/cos_center_logo_small.original.png
    backgroundColor: transparent
servers:
- url: https://api.test.osf.io/v2
tags:


# --- truncated at 32 KB (117 KB total) ---
# Full source: https://artifacts.apis.io/osf/openapi/osf-notification-subscriptions-api-openapi.yml