OSF APIv2 Documentation
This is the official documentation for the OSF (Open Science Framework) API v2. It provides access to the full range of OSF's functionality including project…
Data & analytics#science--math
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the official documentation for the OSF (Open Science Framework) API v2.
It provides access to the full range of OSF's functionality including project management, file handling, user management, registrations, preprints, and metadata operations.
Getting Started
For detailed information on getting started, authentication, and best practices, visit our support page.
API Features
- RESTful resource-oriented API
- Supports pagination, filtering, and sparse fieldsets
- Comprehensive error handling and descriptive error codes
- OAuth-based authentication and authorization
Addons Service Documentation
To view the Addons Service documentation, please click here.
Endpoints 349
Addons
- GETList all addons
/addons/A paginated list of addons configurable with the OSF, for read purposes only. Returns Returns a JSON object containing data and links keys. The data key…
Base
- GETRoot
/Returns A JSON object with meta and links keys. The meta key contains information such as a welcome message from the API, the specified version of the…
CEDAR Metadata
- POSTCreate a CEDAR metadata record for a file
/files/:file_id/cedar_metadata_records/Create a new CEDAR metadata record for the specified file. CEDAR metadata records follow structured templates and can include rich metadata for data sharing… - POSTCreate a CEDAR metadata record for a node
/nodes/:node_id/cedar_metadata_records/Create a new CEDAR metadata record for the specified node. CEDAR metadata records are based on predefined templates and can be associated with nodes or files. - GETRetrieve a CEDAR metadata record
/_/cedar_metadata_records/:record_id/Retrieve a single CEDAR metadata record by its ID. Note: This is a private, unversioned endpoint. Its full URL is… - PUTReplace a CEDAR metadata record
/_/cedar_metadata_records/:record_id/Replace the metadata and/or is_published fields of an existing CEDAR metadata record. Behaves the same as PATCH on this endpoint. - DELETEDelete a CEDAR metadata record
/_/cedar_metadata_records/:record_id/Permanently delete a CEDAR metadata record. Unlike PATCH/PUT, this action is not blocked by the write restriction described below. - PATCHUpdate a CEDAR metadata record
/_/cedar_metadata_records/:record_id/Update the metadata and/or is_published fields of an existing CEDAR metadata record. Only the fields included in the request are changed.
Custom Metadata
- GETRetrieve custom file metadata for a file
/custom_file_metadata_records/:file_id/Retrieve a custom file metadata record associated with a specific file by its GUID. Custom file metadata includes fields such as title, description, language,… - PATCHUpdate custom file metadata for a file
/custom_file_metadata_records/:file_id/Update an existing custom file metadata record. Editable fields include title, description, language, resource type, and funding information. - GETRetrieve custom item metadata for a node or preprint
/custom_item_metadata_records/:guid_id/Retrieve a custom item metadata record associated with a node or preprint by its GUID. Custom item metadata includes fields like language, resource type, and… - PATCHUpdate custom item metadata for a node or preprint
/custom_item_metadata_records/:guid_id/Update an existing custom item metadata record for a node or preprint. Editable fields include language, resource type, and funding information.
Wikis
- GETRetrieve a Wiki
/wikis/:wiki_id/Retrieves the details about a specific wiki. A wiki is a collection of markdown text pages that can be used to describe the project or dataset of contained in… - PUTReplace a Wiki
/wikis/:wiki_id/Renames the specified wiki page by setting its name attribute. This is the only attribute that can be changed through this endpoint; to update the content of… - DELETEDelete a Wiki
/wikis/:wiki_id/Permanently deletes the specified wiki page. The home wiki page cannot be deleted. Permissions Only contributors with write access to the parent node may… - PATCHUpdate a Wiki
/wikis/:wiki_id/Renames the specified wiki page by setting its name attribute. This is the only attribute that can be changed through this endpoint; to update the content of… - GETRetrieve the Content of a Wiki
/wikis/:wiki_id/content/Retrieves the plaintext content of a wiki in markdown format. Returns Returns text/markdown of the wiki content itself. If the request is unsuccessful,… - POSTCreate a new version of a wiki page
/wikis/:wiki_id/versions/Create a new version of a wiki page by submitting updated content. This will store the updated content as a new version, incrementing the version number.… - GETRetrieve details for a specific wiki version
/wikis/:wiki_id/versions/:version_id/Retrieve metadata and basic details about a specific version of a wiki page. Wiki versions store the history of content changes and are immutable snapshots of… - GETRetrieve the raw content of a specific wiki version
/wikis/:wiki_id/versions/:version_id/content/Retrieve the plain text content of a specific version of a wiki page. This endpoint returns the actual content stored in the wiki page for the specified…
Subjects
- GETList available taxonomy subjects
/subjects/Retrieve a list of taxonomy subjects. Subjects categorize content on the OSF. This endpoint returns top-level subjects (those not linked to bepress subjects).… - GETRetrieve a single taxonomy subject
/subjects/:subject_id/Retrieve detailed information about a specific taxonomy subject by its ID. Permissions Publicly accessible (no authentication required). - GETList child subjects for a given subject
/subjects/:subject_id/children/Retrieve all immediate child taxonomy subjects of the specified parent subject. Taxonomy subjects are structured hierarchically. This endpoint returns only…
Requests
- GETRetrieve details for a specific request
/requests/:request_id/Retrieve a specific request by ID. Requests can be associated with either a node or a preprint. Depending on the type, this will return a node-request or a… - GETList actions associated with a request
/requests/:request_id/actions/Retrieve a list of actions performed on a specific request. Currently, actions are supported for preprint-request resources, typically related to withdrawal…
Resources
- GETList resources
/resources/Retrieve a list of resources associated with registrations. - POSTCreate a new resource
/resources/Create a new resource associated with a registration. - GETRetrieve a resource
/resources/:resource_id/Retrieve the full metadata for a specific resource associated with a registration. A resource may include datasets, materials, code, papers, or supplements. - DELETEDelete a resource
/resources/:resource_id/Permanently delete a specific resource. Finalized resources or those linked to active registrations may not be deletable. - PATCHUpdate a resource
/resources/:resource_id/Update one or more metadata fields of a specific resource. Only the fields provided in the request payload will be updated.
Registration Schemas
- GETRetrieve a list of Registration Schemas
/schemas/registrations/Retrieve a paginated list of all active Registration Schemas. Registration Schemas describe the supplemental questions that accompany a registration.… - GETRetrieve a Registration Schema
/schemas/registrations/:registration_schema_idRetrieves the details of a given Registration Schema. Registration Schemas defines the desired supplemental information that should accompany be included in a…
Registration Schema Blocks
- GETRetrieve a list of Registration Schema Blocks for a Schema Response
/schema_responses/:schema_response_id/schema_blocks/This returns a list of all the Registration Schema Blocks are contained in Registration Schema. Returns Returns a JSON object with a data key containing the… - GETRetrieve a Registration Schema Block
/schema_responses/:schema_response_id/schema_blocks/:schema_response_block_idThis returns a Registration Schema Block by it's ID. Returns Returns a JSON object with a data key containing the representation of the requested Registration…
Schema Responses
- GETList all Schema Responses
/schema_responses/This retrieves a paginated list of all active Schema Responses that are public. Returns Returns a JSON object containing data and links keys. The data key… - POSTCreate a new Schema Response
/schema_responses/This endpoint creates a new Schema Response with an in_progress state. A new response can only be created if the current schema response is in an approved… - GETRetrieve a Schema Response
/schema_responses/:schema_response_idThis retrieves a single Schema response using it's id. Returns Returns a JSON object with a data key containing the representation of the requested Schema… - DELETEDelete a Incomplete Schema Response
/schema_responses/:schema_response_idThis endpoint deletes a new Schema Response. Schema Responses can only be deleted in the in_progress state. Once a Schema Response is transitioned to an… - PATCHUpdate a Registration's Schema Response
/schema_responses/:schema_response_idPatching to this endpoint allows one to directly edit the revision responses on the Schema Response of a Registration if that Schema Response is in an…
Schema Response Actions
- GETRetrieve a list of Schema Response Actions for a Schema Response
/schema_responses/:schema_response_id/actions/This retrieves a paginated list of all Schema Response Actions created for a Schema Response. Returns Returns a JSON object with a data key containing the… - POSTCreate a new Schema Response Action
/schema_responses/:schema_response_id/actions/This creates a new Schema Response Action in order to trigger a state transition for a Schema Response. Returns Returns a JSON object with a data key… - GETA Schema Response Action from a Schema Response
/schema_responses/:schema_response_id/actions/:schema_response_action_idRetrieves a Schema Response Action by it's ID. Returns Returns a JSON object with a data key containing the representation of the requested Schema Response…
Draft Registrations
- GETRetrieve a Draft Registration
/nodes/:node_id/draft_registrations/:draft_id/Retrieve the details of a given draft registration. Draft Registrations contain Registration questions that will become part of the Registration. A… - GETRetrieve a list of Draft Registrations
/draft_registrations/Retrieve a list of all currently available Draft Registrations for that user. Permissions Only Draft Registration contributors may view draft registrations.… - POSTCreate a Draft Registration
/draft_registrations/This creates a Draft Registration that can be used to edit and register research. Draft Registrations contain Registration questions that will become part of… - GETRetrieve a Draft Registration
/draft_registrations/:draft_id/Retrieve the details of a given Draft Registration Draft Registrations contain Registration questions that will become part of the Registration. A… - DELETEDelete a draft registration
/draft_registrations/:draft_id/Permanently deletes a draft registration. A draft that has already been registered cannot be deleted. Permissions Only draft registration contributors with… - PATCHUpdate a Draft Registration
/draft_registrations/:draft_id/Updates a Draft Registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Note… - GETRetreive a list Contributors from a Draft Registration
/draft_registrations/:draft_id/contributors/Retrieves the details of all given Contributors for a Draft Registration. Contributors are users who can make changes to the Draft Registration. Contributors… - POSTAdd a contributor to a Draft Registration
/draft_registrations/:draft_id/contributors/Adds a contributor to a Draft Registration, contributors can view, edit, register or delete a Draft Registration depending on their permissions. Contributors… - GETRetreive a Contributor from a Draft Registration
/draft_registrations/:draft_id/contributors/:user_id/Retrieves the details of a given contributor. Contributors are users who can view or edit to the Draft Registrations. Contributors are categorized as either… - GETRetrieve Institutions afilliated with a Draft Registration
/draft_registrations/:draft_id/institutions/Once a properly authenticated user has marked their registration as affiliated with an institution, that institution and any others added will appear in this… - GETRetrieve Subjects associated with a Draft Registration
/draft_registrations/:draft_id/subjects/This retrieves a list of subjects associated with a Draft Registration. Subjects are formatted here in a flat paginated list, but are hierarchical and nested… - GETList bibliographic contributors on a draft registration
/draft_registrations/:draft_id/bibliographic_contributors/Retrieve a list of contributors marked as bibliographic (visible) for a draft registration. - GETRetrieve affiliated institutions for a draft registration
/draft_registrations/:draft_id/relationships/institutions/Retrieve the list of institutions currently affiliated with a draft registration. Returns institution IDs in JSON:API relationship format. - POSTAdd affiliated institutions to a draft registration
/draft_registrations/:draft_id/relationships/institutions/Add one or more institutions to a draft registration by their identifiers. The user must be affiliated with the institutions they are attempting to add. - DELETERemove affiliated institutions from a draft registration
/draft_registrations/:draft_id/relationships/institutions/Remove one or more institutions from the draft registration by their identifiers. This operation only modifies the relationship and does not delete the… - GETRetrieve subjects relationship for a draft registration
/draft_registrations/:draft_id/relationships/subjects/Retrieve the list of subjects currently associated with a draft registration. This endpoint returns subject IDs in the JSON:API relationship format. - POSTAdd subjects to a draft registration
/draft_registrations/:draft_id/relationships/subjects/Add one or more subjects to the draft registration by their identifiers. This modifies the subjects relationship and does not affect the subject resource… - DELETERemove subjects from a draft registration
/draft_registrations/:draft_id/relationships/subjects/Remove one or more subjects from the draft registration by their identifiers. This only updates the relationship and does not delete the subject resource.
Collection Submissions
- GETGet a list of Collection Submission Actions for a Collection Submission
/collection_submissions/:collection_submission_id/actions/This returns a list of the actions that have changed the Collection Submission moderation state. Permissions This information is only available to an admin or…
Collection Providers
- GETList Collections Providers
/providers/collections/This returns a list of the Collections Providers. Permissions This information is public. Returns Returns a JSON object containing data and links keys. The… - GETCollections Providers Detail
/providers/collections/:provider_id/This returns a single Collections Provider entity. Permissions This information is public. Returns Returns a JSON object containing data and links keys.… - GETCollections Providers Licenses List
/providers/collections/:provider_id/licenses/This returns the lists of possible licenses for a Collection. Permissions This information is public. Returns Returns a JSON object containing data and links… - GETList Taxonomies for a Collection Provider (Deprecated)
/providers/collections/:provider_id/taxonomies/Deprecated. Retrieve the full taxonomy for a specific Collection Provider. Deprecated: Use subjects endpoints instead. - GETList Highlighted Taxonomies for a Collection Provider (Deprecated)
/providers/collections/:provider_id/taxonomies/highlighted/Deprecated. Retrieve the list of highlighted taxonomies for a Collection Provider. Deprecated: Use the highlighted subjects endpoint instead. - GETCollections Providers Submissions List
/providers/collections/:provider_id/submissions/This returns a list of all submissions to a Collections Provider entity. Permissions This information is public. Returns Returns a JSON object containing data… - GETCollections Providers Subject List
/provider/collections/:provider_id/subjects/This returns a list of acceptable subjects for a Collections Provider. Permissions This information is public. Returns Returns a JSON object containing data… - GETCollections Providers Highlighted Subject List
/providers/collections/:provider_id/subjects/highlighted/This returns a list of highlighted subjects for a Collections Provider. Permissions This information is public. Returns Returns a JSON object containing data… - GETList Moderators for a Collection Provider
/providers/collections/:provider_id/moderators/Retrieve a list of all moderators assigned to a specific collection provider. Permissions The authenticated user must be an administrator of the collection… - POSTAdd a Moderator to a Collection Provider
/providers/collections/:provider_id/moderators/Add a new moderator to the specified collection provider. Permissions The authenticated user must be an administrator of the collection provider. Request Body… - GETRetrieve a Moderator for a Collection Provider
/providers/collections/:provider_id/moderators/:moderator_id/Retrieve the details of a specific moderator for a collection provider, including their permission group and user information. Permissions - The authenticated… - DELETERemove a Moderator from a Collection Provider
/providers/collections/:provider_id/moderators/:moderator_id/Remove a moderator from a collection provider. Permissions The authenticated user must be an administrator of the collection provider. Returns Returns a 204… - PATCHUpdate a Moderator's Permission Group for a Collection Provider
/providers/collections/:provider_id/moderators/:moderator_id/Update the permission group for a specific moderator on a collection provider. Permissions - The authenticated user must be an administrator of the collection…
Registration Providers
- GETList all Registration Providers
/providers/registrations/A paginated list of all Registration Providers. The returned Registration Providers are sorted by their creation date, with the most recent registrations… - GETRetrieve a Registration Provider
/providers/registrations/:provider_id/Retrieves the details of a Registration Provider. Returns Returns a JSON object with a data key containing the representation of the requested Registration… - GETList Registration Requests
/providers/registrations/:provider_id/registrations/Retrieve a list of requests associated with a specific registration. Registration Requests represent user-initiated requests that may include withdrawal… - GETList Provider Taxonomies (Deprecated)
/providers/registrations/:provider_id/taxonomies/Deprecated. Retrieves a list of all taxonomies associated with the provider. - GETList Highlighted Taxonomies (Deprecated)
/providers/registrations/:provider_id/taxonomies/highlighted/Deprecated. Retrieves highlighted taxonomies associated with the provider. - GETRegistration Providers Licenses List
/providers/registrations/:provider_id/licenses/This returns the lists of possible licenses for a Registration. Permissions This information is public. Returns Returns a JSON object containing data and… - GETList Registration Actions
/providers/registrations/:provider_id/actions/Retrieve a list of actions associated with a specific registration. Registration Actions represent moderator decisions or contributor responses related to the… - GETList Registration Requests
/providers/registrations/:provider_id/requests/Retrieve a list of requests associated with a specific registration. Registration Requests represent user-initiated requests that may include withdrawal… - GETList Registration Schemas for a Provider
/providers/registrations/:provider_id/schemas/Retrieve a list of registration schemas available for a specific registration provider. Registration schemas define the structure and fields that users must… - GETList Subjects for a Registration
/providers/registrations/:provider_id/subjects/Retrieve a list of subjects (taxonomy terms) assigned to a specific registration. Subjects are used to categorize the content of a registration according to a… - GETList Highlighted Subjects
/providers/registrations/:provider_id/subjects/highlighted/Retrieves highlighted subjects for the specified provider. - GETList Moderators
/providers/registrations/:provider_id/moderators/Retrieves a list of moderators associated with a provider. - POSTAdd Moderator
/providers/registrations/:provider_id/moderators/Adds a moderator to the specified provider. - GETRetrieve Moderator Details
/providers/registrations/:provider_id/moderators/:moderator_id/Retrieves details about a moderator associated with a provider. - DELETERemove Moderator
/providers/registrations/:provider_id/moderators/:moderator_id/Removes a moderator from the specified provider. - PATCHUpdate Moderator Permissions
/providers/registrations/:provider_id/moderators/:moderator_id/Updates the permissions of a moderator associated with a provider.
Notification Subscriptions
- GETRetrieve a List of Notification Subscriptions
/subscriptions/Retrieve a paginated list of the authenticated user's notification subscriptions. Each subscription describes the user's preferences for receiving… - GETRetrieve a Notification Subscription
/subscriptions/:subscription_id/Retrieve the details of a specific notification subscription, including its event name and notification frequency. Permissions - The authenticated user must… - PATCHUpdate a Notification Subscription
/subscriptions/:subscription_id/Update the notification frequency for a specific subscription. Only the frequency attribute can be modified. Permissions The authenticated user must be the… - GETList Notification Subscriptions for a Collection Provider
/providers/collections/:provider_id/subscriptions/Retrieve a paginated list of notification subscriptions associated with a specific collection provider for the authenticated user. Each subscription resource… - GETRetrieve a Collection Provider Notification Subscription
/providers/collections/:provider_id/subscriptions/:subscription_id/Retrieve the details of a specific notification subscription associated with a collection provider. Permissions The authenticated user must be the owner of… - PATCHUpdate a Collection Provider Notification Subscription
/providers/collections/:provider_id/subscriptions/:subscription_id/Update the notification frequency for a specific subscription associated with a collection provider. Permissions - The authenticated user must be the owner of… - GETList Preprint Provider Subscriptions
/providers/preprints/:provider_id/subscriptions/Retrieve a paginated list of notification subscriptions for a specific preprint provider associated with the authenticated user. Permissions User must be… - GETRetrieve a Preprint Provider Subscription
/providers/preprints/:provider_id/subscriptions/:subscription_id/Retrieve details of an individual notification subscription associated with a preprint provider. Permissions User must be authenticated and subscribed to the… - PATCHUpdate a Preprint Provider Subscription
/providers/preprints/:provider_id/subscriptions/:subscription_id/Updates a preprint provider subscription by setting the values specified in the request body. Unspecified attributes remain unchanged. The subscription can be… - GETList Registration Provider Subscriptions
/providers/registrations/:provider_id/subscriptions/Retrieve a list of notification subscriptions for a specific registration provider associated with the authenticated user. Permissions User must be… - GETRetrieve a Registration Provider Notification Subscription
/providers/registrations/:provider_id/subscriptions/:subscription_id/Retrieve the details of a specific notification subscription associated with a registration provider. This endpoint allows an authenticated user to view their… - PATCHUpdate a Registration Provider Notification Subscription
/providers/registrations/:provider_id/subscriptions/:subscription_id/Update a specific notification subscription associated with a registration provider. Typically, this endpoint is used to change the notification frequency for… - GETRetrieve a Registration Provider Subscription
/registration_subscriptions/:subscription_id/Retrieve details of a specific notification subscription for a registration provider. Permissions The user must be authenticated and have permission to access… - PATCHUpdate a Registration Provider Subscription
/registration_subscriptions/:subscription_id/Update the frequency of a specific notification subscription for a registration provider. Permissions User must be authenticated and be the owner of the… - GETRetrieve a Collection Subscription
/collection_subscriptions/:subscription_id/Retrieve the details of a specific notification subscription associated with a collection provider. Permissions The authenticated user must be the owner of… - PATCHUpdate a Collection Subscription
/collection_subscriptions/:subscription_id/Update the notification frequency for a specific collection provider subscription. Permissions The authenticated user must be the owner of the subscription.…
Regions
- GETList Regions
/regions/Retrieves a list of available storage regions within OSF. Regions define geographical or cloud storage locations for storing files uploaded through OSF… - GETRegion Detail
/regions/:region_id/Retrieves detailed information for a specific storage region identified by {region_id}. A storage region defines the geographical or cloud-based location used…
Preprint Providers
- GETList all preprint providers
/providers/preprints/A paginated list of all preprint providers. The returned preprint providers are sorted by their creation date, with the most recent preprints appearing first.… - GETRetrieve a preprint provider
/providers/preprints/:provider_id/Retrieves the details of a preprint provider. Returns Returns a JSON object with a data key containing the representation of the requested preprint provider,… - GETList all preprints
/providers/preprints/:provider_id/preprints/A paginated list of preprints from the specified preprint provider. The returned preprints are sorted by their creation date, with the most recent preprints… - GETList Taxonomies for a Preprint Provider (Deprecated)
/providers/preprints/:provider_id/taxonomies/Deprecated. Retrieve a list of all taxonomies (subjects) associated with a specific preprint provider. These taxonomies can be used to categorize and filter… - GETList Highlighted Taxonomies for a Preprint Provider (Deprecated)
/providers/preprints/:provider_id/taxonomies/highlighted/Deprecated. Retrieve a list of highlighted taxonomies (subjects) for a specific preprint provider. Highlighted taxonomies are the primary subjects that the… - GETList Citation Styles for a Preprint Provider
/providers/preprints/:provider_id/citation_styles/Retrieve a list of citation styles supported by a specific preprint provider. These citation styles can be used to generate formatted citations for preprints… - GETList all licenses
/providers/preprints/:provider_id/licenses/A paginated list of the licenses allowed by a preprint provider. Returns Returns a JSON object containing data and links keys. The data key contains an array… - GETList Moderators for a Preprint Provider
/providers/preprints/:provider_id/moderators/Retrieve a list of all moderators assigned to a specific preprint provider. Permissions The authenticated user must be an administrator of the preprint… - POSTAdd a Moderator to a Preprint Provider
/providers/preprints/:provider_id/moderators/Add a new moderator to the specified preprint provider. Permissions The authenticated user must be an administrator of the preprint provider. Request Body… - GETRetrieve a Moderator for a Preprint Provider
/providers/preprints/:provider_id/moderators/:moderator_id/Retrieve the details of a specific moderator for a preprint provider, including their permission group and user information. Permissions - The authenticated… - DELETERemove a Moderator from a Preprint Provider
/providers/preprints/:provider_id/moderators/:moderator_id/Remove a moderator from a preprint provider. Permissions The authenticated user must be an administrator of the preprint provider. Returns Returns a 204 No… - PATCHUpdate a Moderator's Permission Group for a Preprint Provider
/providers/preprints/:provider_id/moderators/:moderator_id/Update the permission group for a specific moderator on a preprint provider. Permissions - The authenticated user must be an administrator of the preprint… - GETList Withdraw Requests for a Preprint Provider
/providers/preprints/:provider_id/withdraw_requests/Retrieve a list of withdraw requests for a specific preprint provider. Withdraw requests are initiated by contributors to request the withdrawal of a preprint… - GETPreprints Providers Subject List
/providers/preprints/:provider_id/subjects/This returns a list of acceptable subjects for a Preprints Provider. Permissions This information is public. Returns Returns a JSON object containing data and… - GETPreprints Providers Highlighted Subject List
/providers/preprints/:provider_id/subjects/highlighted/This returns a list of highlighted subjects for a Preprints Provider. Permissions This information is public. Returns Returns a JSON object containing data…
Tokens
- GETList Personal Access Tokens
/tokens/Retrieve a list of active personal access tokens created by the authenticated user. Personal access tokens are used to authenticate requests to the OSF API… - POSTCreate Personal Access Token
/tokens/Create a new personal access token for authenticating API requests. Request Body A JSON:API-compliant request with token attributes (name) and scopes as… - GETPersonal Access Token Detail
/tokens/:_id/Retrieve details of a specific personal access token. Returns A JSON:API-compliant response with the token's details. Errors - 404 Not Found: Token not found… - DELETEDeactivate Personal Access Token
/tokens/:_id/Deactivate (revoke) a personal access token. The token becomes inactive but is retained in the database. Errors - 404 Not Found: Token does not exist or is… - GETList Scopes of a Personal Access Token
/tokens/:_id/scopes/Retrieve the scopes associated with a specific personal access token. Scopes determine the level of access and operations permitted by the token. Returns A…
Applications
- GETList Registered Applications
/applications/Retrieves a list of OAuth2 applications registered by the authenticated user. Applications allow external services to authenticate via OAuth2. Returns A JSON… - POSTCreate a New Application
/applications/Registers a new OAuth2 application. The authenticated user becomes the owner of the application. - GETRetrieve Application Details
/applications/:client_id/Fetch detailed information for a specific OAuth2 application registered by the authenticated user. - DELETEDeactivate Application
/applications/:client_id/Deactivates an OAuth2 application, hiding it from lists without deleting from the database. - PATCHUpdate Application
/applications/:client_id/Modify fields of an existing OAuth2 application. Fields such as name, description, home_url, or callback_url can be modified. To reset the client secret, set… - POSTReset Application Client Secret
/applications/:client_id/reset/Resets the client secret for a specific OAuth2 application, revoking all associated tokens. Deprecated in API v2.14+
OAuth Scopes
- GETList OAuth Scopes
/scopes/Retrieve a list of publicly available OAuth scopes. Scopes define permissions granted to OAuth applications and personal access tokens. Filtering & Pagination… - GETRetrieve OAuth Scope Detail
/scopes/:scope_id/Retrieve detailed information about a specific OAuth scope. Only publicly available scopes are accessible without special permissions.
Actions
- GETList Review Actions
/actions/reviews/Retrieve a list of review actions accessible to the authenticated user. Review actions document state transitions or user comments related specifically to… - POSTCreate a Node Request Action
/actions/requests/nodes/Create a new action on an existing Node Request. Node Request Actions represent user-driven or automated steps in a moderation workflow for requests related… - POSTCreate a Preprint Request Action
/actions/requests/preprints/Create a new action on a Preprint Request. Preprint Request Actions record transitions and comments during moderation workflows on preprint-related requests,… - GETRetrieve an Action by ID
/actions/:action_id/Retrieve detailed information about a specific Action using its unique identifier. Actions record state transitions, user comments, and workflow triggers…
Identifiers
- GETRetrieve a Specific Identifier
/identifiers/:identifier_id/Retrieve the details of a specific identifier by its unique identifier ID. Identifiers represent permanent references to OSF nodes, often registered with… - GETList all identifiers
/identifiers/:node_id/identifiers/List of all identifiers for a given node. Returns Returns a JSON object containing data and links keys. The data key contains an array of identifiers. Each…
Users
- GETList all users
/users/A paginated list of all users registered on the OSF. The returned users are sorted by their date_registered, with the most recently registered users appearing… - GETRetrieve a user
/users/:user_id/Retrieves details of a specific user. Includes bibliographic information, date of registration, and related resources such as affiliated institutions and… - PATCHUpdate a user
/users/:user_id/Updates user attributes specified in the request body. Unspecified attributes remain unchanged. Updates can be performed via PUT or PATCH. The full_name… - GETList all institutions
/users/:user_id/institutions/A paginated list of institutions that the user is affiliated with. Returns Returns a JSON object containing data and links keys. The data key contains an… - GETList all nodes
/users/:user_id/nodes/A paginated list of nodes that the user is a contributor to. The returned nodes are sorted by their date_modified, with the most recently updated nodes… - GETList all preprints
/users/:user_id/preprints/A paginated list of preprints that the user contributes to. The returned preprints are sorted by their creation date, with the most recent preprints appearing… - GETList all registrations
/users/:user_id/registrations/A paginated list of registrations that the user is a contributor to. The returned registrations are sorted by their date_modified, with the most recently… - GETList all user addons
/users/:user_id/addons/A paginated list of authorized user addons Permissions User addons are visible only to the user that authorized the addon. Returns Returns a JSON object… - GETRetrieve a user addon
/users/:user_id/addons/:provider/Retrieves the details of an authorized user addon Permissions User addons are visible only to the user that authorized the addon. Returns Returns a JSON… - GETList all addon accounts
/users/:user_id/addons/:provider/accounts/A paginated list of addon accounts authorized by this user. Permissions Addon accounts are visible only to the user that authorized the account. Returns… - GETRetrieve an addon account
/users/:user_id/addons/:provider/accounts/:account_id/Retrieves the details of an addon account Permissions Addon accounts are visible only to the user that authorized the account. Returns Returns a JSON object… - POSTClaim a User Account
/users/:user_id/claim/Allows a user to claim an unregistered OSF account. This endpoint is typically used when a contributor is added to a project with an unregistered account, and… - GETList a User's Draft Preprints
/users/:user_id/draft_preprints/Retrieves a list of draft preprints for the specified user. Only the authenticated user can view their own draft preprints. Returns Returns a JSON object with… - GETList a User's Draft Registrations
/users/:user_id/draft_registrations/Retrieves a list of draft registrations for the specified user. Only the authenticated user can view their own draft registrations. Returns Returns a JSON… - GETRetrieve a User's Institution Relationships
/users/:user_id/relationships/institutions/Retrieves the relationships between a user and their affiliated institutions. Only the authenticated user can view their affiliated institutions in this… - DELETERemove Institutions from a User's Affiliations
/users/:user_id/relationships/institutions/Removes one or more institutions from a user's list of affiliations. Usage Notes Only the authenticated user can remove their institution affiliations. - You… - GETRetrieve a User's Settings
/users/:user_id/settings/Retrieves a user's settings, including two-factor authentication status, email subscriptions, and deactivation status. Only the authenticated user can access… - PATCHUpdate a User's Settings
/users/:user_id/settings/Updates a user's settings, including email subscriptions, two-factor authentication setup, and account deactivation status. Only the authenticated user can… - GETList User Email Addresses
/users/:user_id/settings/emails/Retrieves a list of all confirmed and unconfirmed email addresses associated with the user. The authenticated user can view their own email addresses. Returns… - POSTAdd a New Email Address
/users/:user_id/settings/emails/Adds a new unconfirmed email address to the user's account. Once added, the system will send a confirmation email to the specified address. Returns Returns a… - GETRetrieve a User's Email Address
/users/:user_id/settings/emails/:email_id/Retrieves detailed information about a specific email address linked to the user. Only the authenticated user can view their own email addresses. Query… - DELETERemove a User's Email Address
/users/:user_id/settings/emails/:email_id/Deletes an email address from the user's account. If the email is confirmed and verified, it will be removed. - If the email is unconfirmed, it will be… - PATCHUpdate a User's Email Address
/users/:user_id/settings/emails/:email_id/Updates attributes of a user's email address. Allowed Updates Set an email address as primary (must already be confirmed). - Mark an email as verified (must… - POSTRequest User Account Export
/users/:user_id/settings/export/Initiates an export of the user's account data. This endpoint triggers an email to OSF support requesting an export of the user's account data. Only the… - GETList User External Identities
/users/:user_id/settings/identities/Retrieves a list of external identities connected to the user. External identities represent accounts linked from external services or identity providers… - GETRetrieve a User's External Identity
/users/:user_id/settings/identities/:identity_idRetrieves detailed information about a single external identity linked to the user. External identities represent accounts linked from external services or… - DELETERemove a User's External Identity
/users/:user_id/settings/identities/:identity_idDeletes (removes) an external identity from the user's account. Only the authenticated user can delete their own external identities. Returns Returns a 204 No… - POSTChange a User's Password
/users/:user_id/settings/password/Change the password for the specified user. Only the current authenticated user can change their own password using this endpoint. Returns Returns a 204 No…
Citations
- GETList all citation styles
/citations/styles/A paginated list of all standard citation styles available for rendering citations. Returns Returns a JSON object containing data and links keys. The data key… - GETRetrieve a citation style
/citations/styles/:style_id/Retrieves the details of a citation style. Returns Returns a JSON object with a data key containing the representation of the requested citation style, if the…
Comments
- GETRetrieve a comment
/comments/:comment_id/Retrieves the details of a comment Returns Returns a JSON object with a data key containing the representation of the requested comment, if the request was… - DELETEDelete a comment
/comments/:comment_id/Deletes a comment. This action can be undone by setting deleted to False in a comment update request. Returns If the request is successful, no content is…
Files
- GETRetrieve a file
/files/:file_id/Retrieves the details of a file (or folder) Returns Returns a JSON object with a data key containing the representation of the requested file, if the request… - PATCHUpdate a file
/files/:file_id/Updates the specified file by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns Returns JSON with a… - GETList all file versions
/files/:file_id/versions/A paginated list of all file versions. Returns Returns a JSON object containing data and links keys. The data key contains an array of 10 file versions. Each… - GETRetrieve a file version
/files/:file_id/versions/:version_id/Retrieves the details of a file version Returns Returns a JSON object with a data key containing the representation of the requested file, if the request was…
Licenses
- GETList all licenses
/licenses/A paginated list of licenses. The returned licenses are sorted by their name. Returns Returns a JSON object containing data and links keys. The data key… - GETRetrieve a license
/license/:license_id/Retrieves the details of a license. Returns Returns a JSON object with a data key containing the representation of the requested license, if the request is…
Logs
- GETRetrieve a log
/logs/:log_id/Retrieves the details of a log. A log is permanent immutable record of a node's history. A log is created when a user performs one of many actions. See the… - GETActions
/actions/A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: {description}) is as follows: * project_created: A Node…
Institutions
- GETList all institutions
/institutions/A paginated list of all verified institutions. Returns Returns a JSON object containing data and links keys. The data key contains an array of 10… - GETRetrieve an institution
/institutions/:institution_id/Retrieves the details of an institution Returns Returns a JSON object with a data key containing the representation of the requested institution, if the… - GETList all affiliated users
/institutions/:institution_id/users/A paginated list of all users affiliated with an institution. Returns Returns a JSON object containing data and links keys. The data key contains an array of… - GETList all affiliated nodes
/institutions/:institution_id/nodes/A paginated list of all nodes affiliated with an institution. Versioning As of version 2.2, affiliated components (in addition to affiliated top-level… - GETList all affiliated registrations
/institutions/:institution_id/registrations/A paginated list of all registrations affiliated with an institution. Returns Returns a JSON object containing data and links keys. The data key contains an… - GETList nodes affiliated with an institution (relationship data)
/institutions/:institution_id/relationships/nodes/Retrieve relationship data for nodes affiliated with the given institution. Permissions Public nodes: Anyone can view the affiliation. Private nodes: Only… - POSTAdd node relationships to an institution
/institutions/:institution_id/relationships/nodes/Add nodes to an institution's affiliated nodes relationship. Permissions Requires write access on each node being added. User must be affiliated with the… - DELETERemove node relationships from an institution
/institutions/:institution_id/relationships/nodes/Remove nodes from an institution's affiliated nodes relationship. Permissions Requires write access on each node being removed. - GETList registrations affiliated with an institution (relationship data)
/institutions/:institution_id/relationships/registrations/Retrieve relationship data for registrations affiliated with the given institution. Permissions Public registrations: Anyone can view the affiliation. Private… - POSTAdd registration relationships to an institution
/institutions/:institution_id/relationships/registrations/Add registrations to an institution's affiliated registrations relationship. Permissions Requires write access on each registration being added. User must be… - DELETERemove registration relationships from an institution
/institutions/:institution_id/relationships/registrations/Remove registrations from an institution's affiliated registrations relationship. Permissions Requires write access on each registration being removed.
Nodes
- GETList all nodes
/nodes/A paginated list of nodes, representing projects and components, on the OSF. The returned nodes are those which are public or which the user has access to… - POSTCreate a node
/nodes/Creates a new node. On the OSF, nodes are considered projects or components. The difference between a project and a component is that a project is a top-level… - GETRetrieve a node
/nodes/:node_id/Retrieves the details of a given node (project or component). Permissions Only project contributors may retrieve the details of a private node. Attempting to… - DELETEDelete a node
/nodes/:node_id/Permanently deletes a node. This action cannot be undone. Permissions Only project administrators may delete a node. Attempting to delete a node for which you… - PATCHUpdate a node
/nodes/:node_id/Updates a node by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Nodes can be updated… - GETList all addons
/nodes/:node_id/addons/A paginated list of addons connected to the given node or project. Returns Returns a JSON object containing data and links keys. The data key contains an… - GETList all addon folders
/nodes/:node_id/addons/:provider/folders/A paginated list of folders retrieved from the associated third-party (provider) service. Permissions Folders are visible only to the user that authorized the… - GETRetrieve an addon
/nodes/:node_id/addons/:provider/Retrieve details of an individual addon connected to this node. Permissions NodeSettings that are attached to public nodes will give read-only access to… - PATCHUpdate an addon
/nodes/:node_id/addons/:provider/Updates a node addon by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Node addon can… - GETList all child nodes
/nodes/:node_id/children/A paginated list of the next level child nodes for the given node. The returned nodes are sorted by their date_modified, with the most recently updated child… - POSTCreate a child node
/nodes/:node_id/children/Creates a new child node. Note: Creating a child node via this endpoint will function the same as creating a node via the node list endpoint, but the child… - GETRetrieve citation details
/nodes/:node_id/citation/The citation details for a node, in CSL format. Returns Returns a JSON object with a data key that contains the representation of the details necessary for… - GETRetrieve a styled citation
/nodes/:node_id/citation/:style_id/The citation for a node in a specific style. Returns Returns a JSON object with a data key that contains the representation of the node citation, in the… - GETList all comments
/nodes/:node_id/comments/A paginated list of comments related to a given node. The returned comments are sorted by their creation date, with the most recent comments appearing first.… - POSTCreate a comment
/nodes/:node_id/comments/Create a comment on a given node overview page or a reply to a comment on that node. To create a comment on the node overview page, the target type would be… - GETList all contributors
/nodes/:node_id/contributors/A paginated list of the node's contributors, sorted by their index. Contributors are users who can make changes to the node or, in the case of private nodes,… - POSTCreate a contributor
/nodes/:node_id/contributors/Adds a contributor to a node, effectively creating a relationship between the node and a user. Contributors are users who can make changes to the node or, in… - GETRetrieve a contributor
/nodes/:node_id/contributors/:user_id/Retrieves the details of a given contributor. Contributors are users who can make changes to the node or, in the case of private nodes, have read access to… - DELETEDelete a contributor
/nodes/:node_id/contributors/:user_id/Removes a contributor from a node. This request only removes the relationship between the node and the user, it does not delete the user itself. A node must… - PATCHUpdate a contributor
/nodes/:node_id/contributors/:user_id/Updates a contributor by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Contributors… - GETList all draft registrations
/nodes/:node_id/draft_registrations/A paginated list of all of the draft registrations of a given node. Draft Registrations contain Registration questions that will become part of the… - POSTCreate a draft registration based on your current project Node.
/nodes/:node_id/draft_registrations/Initiate a draft registration of the current node. Draft Registrations contain Registration questions that will become part of the Registration. A… - DELETEDelete a draft registration
/nodes/:node_id/draft_registrations/:draft_id/Permanently deletes a draft registration. A draft that has already been registered cannot be deleted. Permissions Only project administrators may delete draft… - PATCHUpdate a draft registration
/nodes/:node_id/draft_registrations/:draft_id/Updates a draft registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Draft… - GETList all storage providers
/nodes/:node_id/files/List of all storage providers that are configured for this node Users of the OSF may access their data on a number of cloud-storage services that have… - GETRetrieve a storage provider
/nodes/:node_id/files/providers/:provider/Retrieves the details of a storage provider enabled on this node. Returns Returns a JSON object with a data key containing the representation of the requested… - GETList all node files
/nodes/:node_id/files/:provider/List of all the files/folders that are attached to your project for a given storage provider. Returns Returns a JSON object containing data and links keys.… - GETRetrieve a file
/nodes/:node_id/files/:provider/:path/Retrieves the details of a file attached to given node (project or component) for the given storage provider. Returns Returns a JSON object with a data key… - GETRetrieve Identifiers for a Node
/nodes/:node_id/identifiers/Retrieve a list of all identifiers (such as DOIs or ARKs) associated with the specified node. Identifiers are unique strings that reference the node in… - POSTMint a New Identifier for a Node
/nodes/:node_id/identifiers/Mint (create) a new identifier for the specified node. Currently, the OSF supports minting DOI identifiers through this endpoint. Once created, identifiers… - GETList all institutions
/nodes/:node_id/institutions/List of all institutions affiliated with this node. Returns Returns a JSON object containing data and links keys. The data key contains an array of up to 10… - GETList all forks of this node
/nodes/:node_id/forks/A paginated list of the current node's forks. The returned fork nodes are sorted by their forked_date, with the most recently forked nodes appearing first.… - POSTCreate a fork of this node
/nodes/:node_id/forks/Creates a fork of the given node. Forking a project creates a copy of an existing node and all of its contents. The fork always points back to the original… - GETList all linked nodes
/nodes/:node_id/linked_nodes/List of all nodes linked to the given node. Returns Returns a JSON object containing data and links keys. The data key contains an array of up to 10 nodes.… - GETList all logs
/nodes/:node_id/logs/A paginated list of all logs associated with a given node. The returned logs are sorted by their date, with the most recents logs appearing first. This list… - GETList all preprints
/nodes/:node_id/preprints/A paginated list of preprints related to a given node. The returned preprints are sorted by their creation date, with the most recent preprints appearing… - GETList all registrations
/nodes/:node_id/registrations/List of all registrations of the given node. Returns Returns a JSON object containing data and links keys. The data key contains an array of up to 10… - GETList all view only links
/nodes/:node_id/view_only_links/List of view only links on a node. Returns Returns a JSON object containing data and links keys. The data key contains an array of up to 10 view only links.… - GETRetrieve a view only link
/nodes/:node_id/view_only_links/:link_id/Retrieves the details of a view only link on a node. Returns Returns a JSON object with a data key containing the representation of the requested view only… - GETList all wikis
/nodes/:node_id/wikis/List of wiki pages on a node. Returns Paginated list of the node's current wiki page versions ordered by their date_modified. Each resource contains the full… - POSTCreate a Wiki
/nodes/:node_id/wikis/Creates a new wiki page on the node with the given name and, optionally, initial content. A wiki page with the given name must not already exist on the node;… - GETList Nodes Linking to a Node
/nodes/:node_id/linked_by_nodes/Retrieve a list of nodes that link to the specified node. Permissions Public nodes are visible to everyone. Private nodes require appropriate permissions to… - GETList Registrations Linking to a Node
/nodes/:node_id/linked_by_registrations/Retrieve a list of registrations that have created links to the specified node. Permissions Public registrations are visible to everyone. Registrations with… - GETRetrieve relationships between a Node and its affiliated Institutions
/nodes/:node_id/relationships/institutions/Retrieve a list of resource identifier objects that represent the institutions affiliated with the given node. Permissions Public nodes will display their… - POSTAdd relationships between a Node and Institutions
/nodes/:node_id/relationships/institutions/Add new affiliated institutions to the node, while keeping the existing ones intact. Permissions The authenticated user must have admin permissions on the… - DELETERemove relationships between a Node and Institutions
/nodes/:node_id/relationships/institutions/Remove specified affiliated institutions from the node. Permissions - The authenticated user must have admin permissions on the node. Request Body - A data… - PATCHReplace relationships between a Node and its affiliated Institutions
/nodes/:node_id/relationships/institutions/Replace all existing affiliated institutions for a node with a new set of institutions. Permissions The authenticated user must have admin permissions on the… - GETRetrieve relationships between a Node and its linked Nodes
/nodes/:node_id/relationships/linked_nodes/Retrieve a list of resource identifier objects that represent the nodes linked to the given node. Permissions Public nodes will display their public linked… - POSTAdd relationships between a Node and linked Nodes
/nodes/:node_id/relationships/linked_nodes/Add new linked nodes to the node, while keeping the existing ones intact. Permissions - The authenticated user must have write permissions on the node.… - DELETERemove relationships between a Node and linked Nodes
/nodes/:node_id/relationships/linked_nodes/Remove specified linked nodes from the node. Permissions - The authenticated user must have write permissions on the node. Request Body - A data array… - PATCHReplace relationships between a Node and its linked Nodes
/nodes/:node_id/relationships/linked_nodes/Replace all existing linked nodes for a node with a new set of linked nodes. Permissions - The authenticated user must have write permissions on the node.… - GETRetrieve relationships between a Node and its linked Registrations
/nodes/:node_id/relationships/linked_registrations/Retrieve a list of resource identifier objects that represent the registrations linked to the given node. Permissions Public nodes will show public linked… - POSTAdd relationships between a Node and linked Registrations
/nodes/:node_id/relationships/linked_registrations/Add new linked registrations to the node, while keeping the existing ones intact. Permissions - The authenticated user must have write permissions on the… - DELETERemove relationships between a Node and linked Registrations
/nodes/:node_id/relationships/linked_registrations/Remove specified linked registrations from the node. Permissions - The authenticated user must have write permissions on the node. Request Body - A data array… - PATCHReplace relationships between a Node and linked Registrations
/nodes/:node_id/relationships/linked_registrations/Replace all existing linked registrations for a node with a new set of linked registrations. Permissions The authenticated user must have write permissions on… - GETRetrieve the relationships between a Node and its Subjects
/nodes/:node_id/relationships/subjects/Retrieve a list of relationship identifiers (resource linkage) representing the subjects associated with a specific node. Permissions Public nodes will… - POSTAdd relationships between a Node and Subjects
/nodes/:node_id/relationships/subjects/Add new subject relationships to a node, keeping the existing subjects intact. Permissions - The authenticated user must have write permissions on the node.… - DELETERemove relationships between a Node and Subjects
/nodes/:node_id/relationships/subjects/Remove specified subject relationships from a node. Permissions - The authenticated user must have write permissions on the node. Request Body - A data array… - PATCHUpdate the relationships between a Node and its Subjects
/nodes/:node_id/relationships/subjects/Replace all existing subject relationships on a node with a new list of subjects. Permissions - The authenticated user must have write permissions on the… - GETList Requests for a Node
/nodes/:node_id/requests/Retrieve a list of requests associated with a specific node. Requests include actions such as registration approval, withdrawal, or other moderation-related… - GETRetrieve Node Settings
/nodes/:node_id/settings/Retrieve the settings for a specific node. This includes details such as whether wiki functionality is enabled, if comments are enabled, and other… - PATCHUpdate Node Settings
/nodes/:node_id/settings/Update settings for a specific node. You can modify properties like wiki_enabled, comments_enabled, or make the node public/private. Permissions - Only users… - GETList Storage Providers for a Node
/nodes/:node_id/storage/Retrieve the list of storage providers associated with a specific node. Each node in the OSF automatically has an OSF Storage provider, and may have… - GETList Subjects for a Node
/nodes/:node_id/subjects/Retrieve the list of taxonomy subjects assigned to a specific node. Subjects represent thematic classifications for the content of a node. A node can have…
Preprints
- GETList all preprints
/preprints/A paginated list of preprints from all preprint providers. The returned preprints are sorted by their creation date, with the most recent preprints appearing… - POSTCreate a preprint
/preprints/Creates a new preprint. Returns Returns a JSON object with a data key containing the representation of the created preprint, if the request is successful. If… - GETList preprint versions
/preprints/:preprint_id/versions/A paginated list of all preprint versions for requested preprint. The returned preprints are sorted by their creation date, with the most recent preprints… - POSTCreate a preprint version
/preprints/:preprint_id/versions/Creates a new preprint version from requested preprint. Returns Returns a JSON object with a data key containing the representation of the created preprint,… - GETRetrieve a preprint
/preprints/:preprint_id/Retrieves the details of a preprint. Returns Returns a JSON object with a data key containing the representation of the requested preprint, if the request is… - PATCHUpdate a preprint
/preprints/:preprint_id/Updates the specified preprint by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns Returns a JSON… - GETRetrieve citation details
/preprints/:preprint_id/citation/The citation details for a preprint, in CSL format. Returns Returns a JSON object with a data key that contains the representation of the details necessary… - GETRetrieve a styled citation
/preprints/:preprint_id/citation/:style_id/The citation for a preprint in a specific style. Returns Returns a JSON object with a data key that contains the representation of the preprint citation, in… - GETList all Contributors for a Preprint
/preprints/:preprint_id/contributors/A paginated list of the Preprint's Contributors, sorted by their index. Contributors are users who can make changes to the Preprint. Contributors with WRITE… - POSTCreate a Contributor
/preprints/:preprint_id/contributors/Adds a contributor to a Preprint, effectively creating a relationship between the Preprint and a user. Contributors are users who can make changes to the… - GETRetrieve a contributor
/preprints/:preprint_id/contributors/:user_id/Retrieves the details of a contributor on this Preprint. Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions… - GETList all Bibliographic Contributors
/preprints/:preprint_id/bibliographic_contributors/A paginated list of the Preprint's Bibliographic Contributors, sorted by their index. Contributors are users who can make changes to the Preprint.… - GETList all Institutional Affilations for a Preprint
/preprints/:preprint_id/institutions/A paginated list of the Preprint's Institutions, sorted by their index. Institutions are organizations affiliated with the Preprint. Contributors may be… - GETList all Institutions for a Preprint
/preprints/:preprint_id/relationships/institutions/A paginated list of the Preprint's Institutions, sorted by their index. Institutions are organizations affiliated with the Preprint. Contributors may be… - PUTUpdate a Preprints Institutional Affilation
/preprints/:preprint_id/relationships/institutions/Updates an institution affilation to a Preprint, effectively creating or removing a relationship between the Preprint and that user's affilation to the… - GETList storage providers for a preprint
/preprints/:preprint_id/files/Retrieve a list of storage providers for the specified preprint. Only "osfstorage" is supported for preprints. Permissions Public storage providers are… - GETList files for a preprint in osfstorage
/preprints/:preprint_id/files/osfstorage/Retrieve a list of files stored in the osfstorage provider for the specified preprint. Only "osfstorage" is available for preprints. Permissions Public files… - GETList identifiers for a preprint
/preprints/:preprint_id/identifiers/Retrieves a list of identifiers associated with the specified preprint. Identifiers include DOIs, ARKs, and other unique resource locators. Permissions Public… - GETRetrieve the relationship to the supplemental node of the preprint
/preprints/:preprint_id/relationships/node/Retrieve a relationship object that points to the supplemental node associated with this preprint. Permissions Public preprints will return their supplemental… - DELETERemove the supplemental node relationship from the preprint
/preprints/:preprint_id/relationships/node/Remove the link between the preprint and its supplemental node. Permissions - Must have write permissions on the preprint. - PATCHUpdate the relationship to the supplemental node of the preprint
/preprints/:preprint_id/relationships/node/Update the supplemental node relationship for the specified preprint. Permissions - Must have write permissions on both the preprint and the target node. - POSTCreate a Preprint Request
/preprints/:preprint_id/requests/Create a new request on the specified preprint. Typically used for withdrawal requests. Permissions - Must be an admin contributor on the preprint to create a… - GETList Review Actions for a Preprint
/preprints/:preprint_id/review_actions/Retrieve the list of review actions for the specified preprint. Review actions track state transitions and comments made during the review process.… - GETList Preprint Subjects
/preprints/:preprint_id/subjects/Retrieve the list of subjects (taxonomy terms) associated with a specific preprint. Permissions - Preprint subjects are publicly accessible for published…
Registrations
- GETList all registrations
/registrations/A paginated list of registrations on the OSF to which the user has access. The returned registrations are those which are public or which the user has access… - GETRetrieve a registration
/registrations/:registration_id/Retrieve the details of a given registration. Permissions Only project contributors may retrieve the details of a registration that is embargoed, or has not… - PATCHUpdate a registration
/registrations/:registration_id/Updates a registration's privacy from private to public. Registrations can be updated with either a PUT or PATCH request. The public field is the only field… - GETList all citation styles
/registrations/:registration_id/citations/A paginated list of the registration's alternative citation styles Returns Returns a JSON object containing data and links keys. The data key contains an… - GETRetrieve a citation
/registrations/:registration_id/citations/:citation_id/Retrieves the citation style details for a registration, in CSL format. Returns Returns a JSON object with a data key that contains the representation of the… - GETList all child registrations
/registrations/:registration_id/children/A paginated list of children of a registration. The list consists of the next level child registrations for the given registration. The returned registrations… - GETList all comments
/registrations/:registration_id/comments/A paginated list of the registration's comments. The returned comments are sorted by their creation date, with the most recent comments appearing first.… - GETList all contributors
/registrations/:registration_id/contributors/A paginated list of all contributors on this registration. The returned contributors are sorted by their index. Contributors are users who can make changes to… - GETRetrieve a contributor
/registrations/:registration_id/contributors/:user_id/Retrieves the details of a contributor on this registration. Returns Returns a JSON object with a data key containing the representation of the requested… - GETList all storage providers
/registrations/:registration_id/files/A paginated list of storage providers enabled on the registration Users of the OSF may access their data on a number of cloud-storage services that have… - GETList all files
/registrations/:registration_id/files/:provider/List of all the registration's files/folders for a given storage provider. Returns Returns a JSON object containing data and links keys. The data key contains… - GETRetrieve a file
/registrations/:registration_id/files/:provider/:path/Retrieves the details of a registration file for the given storage provider. Returns Returns a JSON object with a data key containing the representation of… - GETList all forks
/registrations/:registration_id/forks/A paginated list of the registration’s forks The returned forks are sorted by their forked_date, with the most recent forks appearing first. Forking a… - POSTCreate a fork
/registrations/:registration_id/forks/Creates a fork of the given registration. Forking a project creates a copy of an existing registration and all of its contents. The fork always points back to… - GETList all identifiers
/registrations/:registration_id/identifiers/A paginated list of the registration's identifiers. Returns Returns a JSON object containing data and links keys. The data key contains an array of… - GETList all institutions
/registrations/:registration_id/institutions/A paginated list of institutions affiliated with the registration. Returns Returns a JSON object containing data and links keys. The data key contains an… - GETList all linked nodes
/registrations/:registration_id/linked_nodes/List of all nodes linked to the registration. Returns Returns a JSON object containing data and links keys. The data key contains an array of up to 10 nodes.… - GETList all logs
/registrations/:registration_id/logs/A paginated list of the registration's logs. The returned logs are sorted by their date, with the most recents logs appearing first. Returns Returns a JSON… - GETList Registration Actions
/registrations/:registration_id/actions/Retrieve a list of actions performed on a specific registration. Actions represent state transitions or moderation events, such as submission, approval,…
Showing 300 of 349 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.test.osf.io/v2- Authentication
- None declared in the description
- Operations
- 349 operations on 246 pathsGET 235POST 48PATCH 33DELETE 30PUT 3
6 marked deprecated - Main resources
- Nodes 64Registrations 40Users 28Preprints 24Collections 21Draft Registrations 18Notification Subscriptions 16Registration Providers 16Preprint Providers 15Institutions 14
- Description format
- Swagger 2.0, API version
2.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Osf's published OpenAPI description
How to test the OSF APIv2 Documentation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OSF APIv2 Documentation collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List all addons” (GET /addons/), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the OSF APIv2 Documentation?
This is the official documentation for the OSF (Open Science Framework) API v2. It provides access to the full range of OSF's functionality including project… It is listed under Data & analytics and has 349 endpoints.
Who publishes the OSF APIv2 Documentation?
It is listed from Osf's public API description (an OpenAPI document), not published by Osf on Swastik Codes. Anyone who controls osf.io can claim the profile by adding a DNS TXT record.
What is the base URL of the OSF APIv2 Documentation?
Requests go to https://api.test.osf.io/v2. Endpoint paths are added to this base URL.
How do I authenticate with the OSF APIv2 Documentation?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the OSF APIv2 Documentation have?
349 operations on 246 paths (235 GET, 48 POST, 33 PATCH, 30 DELETE, 3 PUT). The largest groups are Nodes, Registrations, Users, Preprints.
Is forking the OSF APIv2 Documentation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.