OSF APIv2 Documentation

OpenAPI apis-guru open_data

Homepage: https://api.apis.guru/v2/specs/osf.io/2.0.json
Provider: osf.io
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/osf.io/2.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/osf.io/2.0/openapi.yaml

Tools (158)

Extracted live via the executor SDK.

addons.addonsList

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 contains an array of up to 10 addons. Each resource in the array is a separate addon object.
The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error.
base.baseRead

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 request, and the full representation of the current user, if authentication credentials were provided in the request.
The links key contains links to the following entity collections: , collections [blocked], , , [registration schemas](#tag/Registration Schemas), , ,
citations.citationsStylesList

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 contains an array of 10 citation styles. Each resource in the array is a separate citation syle and contains the full representation of the citation style object.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include citation styles that match your filters by utilizing the filter query parameter, e.g. .
Citation styles may be filtered by their id, title, short-title, and summary.
Errors
This request should never return an error.
citations.citationsStylesRead

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 request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
collections.collectionsAddMetadata

List of user created metadata for entities within a collection.
Permissions
To edit this collection a user must have collections write permissions
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsCollectedMetadata

Permissions
In order to view these subject it must be a public collection or a user must have read permissions for collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error, other then permissions errors.
collections.collectionsCreate

Retrieves a list collections, either public or related to the user
Permissions
Anonymous users are able to see all public collections at this endpoint. Logged in users will only be able to see their own content.
Comments on private nodes are only visible to contributors and administrators on the parent node.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of comment objects. Each resource in the array is a separate comment object.
The links key contains a dictionary of links that can be used for .
collections.collectionsDelete

Deletes a collection, if the user has appropriate permissions.
Permissions
Users must have write permissions on a collection in order to delete it
Returns
Nothing is returned in the body
collections.collectionsDetail

Retrieves a collection, if the user has appropriate permissions.
Permissions
Anonymous users are able to see all public collections at this endpoint. Logged in users will only be able to see their own content.
Returns
Returns a JSON object containing data and links keys.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedNodesList

List of all nodes linked to the given collection.
Permissions
This returns all public nodes associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 nodes. Each resource in the array is a separate node object.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedNodesRelationships

This endpoint allow users to a add a node to a collection by issuing a POST request.
Permissions
This returns all public nodes associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of comment objects. Each resource in the array is a separate comment object.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedNodesRelationshipsCreate

List of all the node ids linked to the given collection.
Permissions
This returns all public nodes associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedNodesRelationshipsDelete

This removes associated nodes from a collection
Permissions
Any user with write permissions on this collection should be to remove nodes from this collection.
Returns
Nothing in the response body.
collections.collectionsLinkedPreprintsList

List of all preprints linked to the given collection.
Permissions
This returns all public preprints associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 nodes. Each resource in the array is a separate node object.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedRegistrationsList

List of all registrations linked to the given collection.
Permissions
This returns all public registrations associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 nodes. Each resource in the array is a separate node object.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedRegistrationsRelationships

This endpoint allow users to a add a registration to a collection by issuing a POST request.
Permissions
This returns all public registrations associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of comment objects. Each resource in the array is a separate comment object.
The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedRegistrationsRelationshipsCreate

List of all the registration ids linked to the given collection.
Permissions
This returns all public registrations associated with this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsLinkedRegistrationsRelationshipsDelete

This removes associated registrations from a collection
Permissions
Any user with write permissions on this collection should be to remove registrations from this collection.
Returns
Nothing in the response body.
collections.collectionsList

Retrieves a list collections, either public or related to the user
Permissions
Anonymous users are able to see all public collections at this endpoint. Logged in users will only be able to see their own content.
Comments on private nodes are only visible to contributors and administrators on the parent node.
Returns
Returns a JSON object containing data and links keys. The links key contains a dictionary of links that can be used for .
collections.collectionsMetadataDelete

Permissions
Only a user with collection admin permissions can delete collected metadata
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsMetadataDetail

List of user created metadata for entities within a collection.
Permissions
To edit this collection a user must have collections write permissions
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsMetadataRegistrationsDetail

Permissions
In order to view this metadata it must be public or a user must have read permissions for collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error.
collections.collectionsMetadataRegistrationsList

List of user created metadata for entities within a collection.
Permissions
In order to view this metadata it must be public or a user must have read permissions for collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error.
collections.collectionsMetadataSubjectsRelationships

Permissions
This is public for a logged out user when an entity is public.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
collections.collectionsMetadataSubjectsRelationshipsUpdate

Permissions
This is editable for a user with a write permission for this collection.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of nodes ids. The links key contains a dictionary of links that can be used for .
comments.commentsDelete

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 returned.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
comments.commentsPut

Updates the specified comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Returns
Returns JSON with a data key containing the new representation of the updated comment, if the request is successful.
If the request is unsuccessful, JSON with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
comments.commentsRead

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 successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.deleteDraftRegistrationsDraftId

Permanently deletes a draft registration. A draft that has already been registered cannot be deleted.
Permissions
Only draft registration contributors with ADMIN permissions may delete draft registrations
Returns
If the request is successful, no content is returned. If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the list of error codes [blocked] to understand why this request may have failed.
draftRegistrations.draftRegistrationContributorsCreate

Adds a contributor to a Draft Registration, contributors can view, edit, register or delete a Draft Registration depending on their permissions. Contributors are categorized as either "bibliographic" or "non-bibliographic" contributors. From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Permissions
Only project administrators can add contributors to a Draft Registration.
Required
A relationship object with a data key, containing the users type and valid user ID is required. All attributes describing the relationship between the node and the user are optional.
Returns
Returns a JSON object with a data key containing the representation of the new contributor, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.draftRegistrationContributorsList

Retrieves the details of all given Contributors for a Draft Registration. Contributors are users who can make changes to the Draft Registration. Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
draftRegistrations.draftRegistrationsCreate

This creates a Draft Registration that can be used to edit and register research. Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited. A Draft Registration created by this endpoint will not have a Project linked with it by default, but if the user includes a branched_from attribute in their Draft Registration creation payload with the value of the branched_from being guid of a Project they have permissions for the Draft Registration will be linked to the Project. If you linked your Draft Registration on a Project, your original Project remains editable and will now have the Draft Registration linked to it.
Permissions
Any user can create a Draft Registration. If the branched_from attribute is provided, then the user must be an ADMIN contributor on the Project being registered.
Required
Required fields for creating a Draft Registration include:
schema_id
Returns
Returns a JSON object with a data key containing the representation of the created Draft Registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.draftRegistrationsRead

Retrieve a list of all currently available Draft Registrations for that user.
Permissions
Only Draft Registration contributors may view draft registrations.
Returns
Returns a JSON object with a data key containing the representation of the requested draft registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.getDraftRegistrationsDraftId

Retrieve the details of a given Draft Registration Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited.
If you based your Draft Registration on a Project, your original Project remains editable but will now have the Draft Registration linked to it.
Permissions
Only draft registration contributors may view draft registrations.
Returns
Returns a JSON object with a data key containing the representation of the requested draft registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.getDraftRegistrationsDraftIdContributorsUserId

Retrieves the details of a given contributor.
Contributors are users who can view or edit to the Draft Registrations.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
draftRegistrations.getDraftRegistrationsDraftIdInstitutions

Once a properly authenticated user has marked their registration as affiliated with an institution, that institution and any others added will appear in this list.
draftRegistrations.nodesDraftRegistrationsRead

Retrieve the details of a given draft registration. Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited.
Your original project remains editable but will now have the draft registration linked to it.
Permissions
Only project administrators may view draft registrations.
Returns
Returns a JSON object with a data key containing the representation of the requested draft registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
draftRegistrations.nodesDraftRegistrationsSubjects

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 by specificity of subject matter.
draftRegistrations.patchDraftRegistrationsDraftId

Updates a Draft Registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Note this will not register or change the machine state of a Draft Registration, it can only edit the Draft Registration's attributes prior to its registration.
Permissions
Only draft registration contributors may view draft registrations and only draft registration contributors with WRITE or ADMIN permissions may update draft registrations.
Returns
Returns a JSON object with a data key containing the new representation of the updated draft registration, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
files.filesDetail

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 was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Waterbutler API actions
Files can be modified through the Waterbutler API routes found in links (new_folder, move, upload, download, and delete).
Download (files)
To download a file, issue a GET request against the download link. The response will have the Content-Disposition header set, which will will trigger a download in a browser.
Create Subfolder (folders)
You can create a subfolder of an existing folder by issuing a PUT request against the new_folder link. The ?kind=folder portion of the query parameter is already included in the new_folder link. The name of the new subfolder should be provided in the name query parameter. The response will contain a WaterButler folder entity. If a folder with that name already exists in the parent directory, the server will return a 409 Conflict error response.
Upload New File (folders)
To upload a file to a folder, issue a PUT request to the folder's upload link with the raw file data in the request body, and the kind and name query parameters set to 'file' and the desired name of the file. The response will contain a WaterButler file entity that describes the new file. If a file with the same name already exists in the folder, the server will return a 409 Conflict error response.
Update Existing File (file)
To update an existing file, issue a PUT request to the file's upload link with the raw file data in the request body and the kind query parameter set to "file". The update action will create a new version of the file. The response will contain a WaterButler file entity that describes the updated file.
Rename (files, folders)
To rename a file or folder, issue a POST request to the move link with the action body parameter set to "rename" and the rename body parameter set to the desired name. The response will contain either a folder entity or file entity with the new name.
Move & Copy (files, folders)
Move and copy actions both use the same request structure, a POST to the move url, but with different values for the action body parameters. The path parameter is also required and should be the OSF path attribute of the folder being written to. The rename and conflict parameters are optional. If you wish to change the name of the file or folder at its destination, set the rename parameter to the new name. The conflict param governs how name clashes are resolved. Possible values are replace and keep. replace is the default and will overwrite the file that already exists in the target folder. keep will attempt to keep both by adding a suffix to the new file's name until it no longer conflicts. The suffix will be ' (x)' where x is a increasing integer starting from 1. This behavior is intended to mimic that of the OS X Finder. The response will contain either a folder entity or file entity with the new name. Files and folders can also be moved between nodes and providers. The resource parameter is the id of the node under which the file/folder should be moved. It must agree with the path parameter, that is the path must identify a valid folder under the node identified by resource. Likewise, the provider parameter may be used to move the file/folder to another storage provider, but both the resource and path parameters must belong to a node and folder already extant on that provider. Both resource and provider default to the current node and providers. If a moved/copied file is overwriting an existing file, a 200 OK response will be returned. Otherwise, a 201 Created will be returned.
Delete (file, folders)
To delete a file or folder send a DELETE request to the delete link. Nothing will be returned in the response body.
files.filesPatch

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 data key containing the new representation of the updated file, if the request is successful.
If the request is unsuccessful, JSON with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
files.filesVersionDetail

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 successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
files.filesVersions

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 resource in the array is a separate file version object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
institutions.institutionsDetail

Retrieves the details of an institution
Returns
Returns a JSON object with a data key containing the representation of the requested institution, if the request was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
institutions.institutionsList

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 institutions. Each resource in the array is a separate institution object.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include institutions that match your filters by utilizing the filter query parameter, e.g. .
Institutions may be filtered by their id, name, and auth_url
institutions.institutionsNodeList

A paginated list of all nodes affiliated with an institution.
Versioning
As of version 2.2, affiliated components (in addition to affiliated top-level projects) are returned from this endpoint.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 nodes. Each resource in the array is a separate nodes object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their id, title, description, public, tags, category, date_created, date_modified, root, parent, contributors, and preprint
institutions.institutionsRegistrationList

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 array of 10 registrations. Each resource in the array is a separate users object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. .
Registrations may be filtered by their id, title, description, public, tags, category, date_created, date_modified, root, parent, contributors, and preprint
institutions.institutionsUsersList

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 10 users. Each resource in the array is a separate users object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
You can optionally request that the response only include users that match your filters by utilizing the filter query parameter, e.g. .
Users may be filtered by their id, full_name, given_name, middle_names, and family_name
licenses.licenseList

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 contains an array of 10 licenses. Each resource in the array is a separate license object and contains the full representation of the license, meaning additional requests to a license's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include licenses that match your filters by utilizing the filter query parameter, e.g. .
Licenses may be filtered by their id, and name.
licenses.licensesRead

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 successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
logs.logsActions
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 is created
- project_registered: A Node is registered
- project_deleted: A Node is deleted
- created_from: A Node is created using an existing Node as a template
- pointer_created: A Pointer is created
- pointer_forked: A Pointer is forked
- pointer_removed: A Pointer is removed
- node_removed: A component is deleted
- node_forked: A Node is forked
- made_public: A Node is made public
- made_private: A Node is made private
- tag_added: A tag is added to a Node
- tag_removed: A tag is removed from a Node
- edit_title: A Node's title is changed
- edit_description: A Node's description is changed
- updated_fields: One or more of a Node's fields are changed
- external_ids_added: An external identifier is added to a Node (e.g. DOI, ARK)
- view_only_link_added: A view-only link was added to a Node
- view_only_link_removed: A view-only link was removed from a Node
- contributor_added: A Contributor is added to a Node
- contributor_removed: A Contributor is removed from a Node
- contributors_reordered: A Contributor's position in a Node's bibliography is changed
- permissions_updated: A Contributor`s permissions on a Node are changed
- made_contributor_visible: A Contributor is made bibliographically visible on a Node
- made_contributor_invisible: A Contributor is made bibliographically invisible on a Node
- wiki_updated: A Node's wiki is updated
- wiki_deleted: A Node's wiki is deleted
- wiki_renamed: A Node's wiki is renamed
- made_wiki_public: A Node's wiki is made public
- made_wiki_private: A Node's wiki is made private
- addon_added: An add-on is linked to a Node
- addon_removed: An add-on is unlinked from a Node
- addon_file_moved: A File in a Node's linked add-on is moved
- addon_file_copied: A File in a Node's linked add-on is copied
- addon_file_renamed: A File in a Node's linked add-on is renamed
- node_authorized: An addon is authorized for a project
- node_deauthorized: An addon is deauthorized for a project
- folder_created: A Folder is created in a Node's linked add-on
- file_added: A File is added to a Node's linked add-on
- file_updated: A File is updated on a Node's linked add-on
- file_removed: A File is removed from a Node's linked add-on
- file_restored: A File is restored in a Node's linked add-on
- comment_added: A Comment is added to some item
- comment_removed: A Comment is removed from some item
- comment_updated: A Comment is updated on some item
- embargo_initiated: An embargoed Registration is proposed on a Node
- embargo_approved: A proposed Embargo of a Node is approved
- embargo_cancelled: A proposed Embargo of a Node is cancelled
- embargo_completed: A proposed Embargo of a Node is completed
- retraction_initiated: A Withdrawal of a Registration is proposed
- retraction_approved: A Withdrawal of a Registration is approved
- retraction_cancelled: A Withdrawal of a Registration is cancelled
- registration_initiated: A Registration of a Node is proposed
- registration_approved: A proposed Registration is approved
- registration_cancelled: A proposed Registration is cancelled`
logs.logsRead

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 section for more details.
Returns
Returns a JSON object with a data key containing the representation of the requested log, if the request was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesAddonRead

Retrieve details of an individual addon connected to this node.
Permissions
NodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes. Any users with write or admin access to the node are able to deauthorize an enabled addon, but only the addon authorizer is able to change the configuration (i.e. selected folder) of an already-configured NodeSettings entity.
Returns
Returns a JSON object with a data key containing the details of the requested addon, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesAddonsFoldersList

A paginated list of folders retrieved from the associated third-party (provider) service.
Permissions
Folders are visible only to the user that authorized the addon.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of addon folder objects. Each resource in the array is a separate addon folder object and contains the full representation of the addon folder, meaning additional requests to a addon folder's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
nodes.nodesAddonsList

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 array of at most 10 addon objects. Each resource in the array is a separate addon object and contains the full representation of the addon, meaning additional requests to a addon's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
nodes.nodesChildrenCreate

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 node will have the given node set as its parent.
Permissions
Only write contributors may create children nodes.
Required
Required fields for creating a node include:
&nbsptitle
&nbspcategory
Note: nodes default to private unless the public field is explicitly set to true in the request payload.
Returns
Returns a JSON object with a data key containing the representation of the created node, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesChildrenList

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 nodes appearing first.
The list will include child nodes that are public, as well as child nodes that are private, if the authenticated user has permission to view them.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 child nodes. If the given node has zero child nodes, the data key will contain an empty array. Each resource in the array is a separate node object and contains the full representation of the child node, meaning additional requests to the child node's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, preprint, and contributors.
Most fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as true, false, 0 or 1. Note that quoting true or false in the query will cause the match to fail.
nodes.nodesCitationList

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 the node citation.
nodes.nodesCitationRead

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 requested style.
nodes.nodesCommentCreate

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 "nodes" and the target id would be the node id.
To reply to a comment on this node, the target type would be "comments" and the target id would be the id of the comment to reply to.
Required
A relationship object with a data key, containing the target (comments or nodes) type and a target id is required. In addition, the content attribute describing the relationship between the node and the comment is required.
Returns
Returns a JSON object with a data key containing the representation of the new comment, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesCommentsList

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.
Permissions
Comments on public nodes are given read-only access to everyone.
If the node comment-level is private, only contributors have permission to comment.
If the comment-level is public, any logged-in OSF user can comment.
Comments on private nodes are only visible to contributors and administrators on the parent node.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of comment objects. Each resource in the array is a separate comment object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include comments that match your filters by utilizing the filter query parameter, e.g.
Nodes may be filtered by their deleted, target_id, date_created, date_modified.
Most fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as true, false, 0 or 1. Note that quoting true or false in the query will cause the match to fail.
nodes.nodesContributorsCreate

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 the case of private nodes, have read access to the node.
Contributors are categorized as either "bibliographic" or "non-bibliographic" contributors. From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Permissions
Only project administrators can add contributors to a node.
Required
A relationship object with a data key, containing the users type and valid user ID is required.
All attributes describing the relationship between the node and the user are optional.
Returns
Returns a JSON object with a data key containing the representation of the new contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesContributorsDelete

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 always have at least one admin, and attempting to remove the only admin from a node will result in a 400 Bad Request response.
Permissions
A user can remove themselves as a node contributor. Otherwise, only project administrators can remove contributors.
Returns
If the request is successful, no content is returned.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesContributorsList

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, have read access to the node.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Note that if an anonymous view_only key is being used to view the list of contributors, the user relationship will not be exposed and the contributor ID will be an empty string.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 contributors. Each resource in the array contains the full representation of the contributor, meaning additional requests to a contributor's detail view are not necessary. Additionally, the full representation of the user this contributor represents is automatically embedded within the data key of the response.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include contributors that match your filters by utilizing the filter query parameter, e.g. .
Contributors may be filtered by their bibliographic and permission attributes.
nodes.nodesContributorsPartialUpdate

Updates a contributor by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.
Contributors can be updated with either a PUT or PATCH request. Since this endpoint has no mandatory attributes, PUT and PATCH are functionally the same.
Permissions
Only project administrators can update the contributors on a node.
Returns
Returns a JSON object with a data key containing the new representation of the updated contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
If the given user is not already in the contributor list, a 404 Not Found error will be returned. A node must always have at least one admin, and any attempt to downgrade the permissions of a sole admin will result in a 400 Bad Request error.
nodes.nodesContributorsRead

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 the node.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Returns
Returns a JSON object with a data key containing the representation of the requested contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesCreate

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 node, and a component is a child of a project.
Additionally, nodes have a category field that includes project as an option. The categorization determines what icon is displayed with the node on the OSF, and helps with search organization. Projects (top-level nodes) may have a category other than project, and components (children) may have a category of project.
Required
Required fields for creating a node include:
&nbsptitle
&nbspcategory
Note: Nodes default to private unless the public field is explicitly set to true in the request payload.
Returns
Returns a JSON object with a data key containing the representation of the created node, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesDelete

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 are not an administrator will result in a 403 Forbidden response.
Returns
If the request is successful, no content is returned.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesDraftRegistrationsCreate

Initiate a draft registration of the current node. Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited.
Your original project remains editable but will now have the draft registration linked to it.
Permissions
Only project administrators may view create registrations.
Required
Required fields for creating a draft registration include:
schema_id
Returns
Returns a JSON object with a data key containing the representation of the created draft registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesDraftRegistrationsDelete

Permanently deletes a draft registration. A draft that has already been registered cannot be deleted.
Permissions
Only project administrators may delete draft registrations.
Returns
If the request is successful, no content is returned.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the list of error codes [blocked] to understand why this request may have failed.
nodes.nodesDraftRegistrationsList

A paginated list of all of the draft registrations of a given node.
Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited.
Your original project remains editable but will now have the draft registration linked to it.
Permissions
Only project administrators may view draft registrations.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 draft registrations. Each resource in the array is a separate draft registration object and contains the full representation of the draft registration, meaning additional requests to a draft registration's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
nodes.nodesDraftRegistrationsPartialUpdate

Updates a draft registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.
Draft Registrations contain Registration questions that will become part of the Registration. Answer the questions in the draft registration supplement by sending update requests until you are ready to submit the draft.
The registration supplement of a draft registration cannot be updated after the draft has been created.
When updating a draft registration, registration_metadata is required. It must be a dictionary with keys as question ids in the registration form, and values as nested dictionaries matching the specific format in the [registration schema](TODO: link me pls).
If a question is multiple-choice, the question response must exactly match one of the possible choices.
Permissions
Only project administrators may update draft registrations.
Returns
Returns a JSON object with a data key containing the new representation of the updated draft registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesFilesList

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.
The data key contains an array of files. Each resource in the array is a separate file object and contains the full representation of the file.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include files that match your filters by utilizing the filter query parameter, e.g.
Node files may be filtered by id, name, node, kind, path, provider, size, and last_touched.
Waterbutler API actions
Files can be modified through the Waterbutler API routes found in links (new_folder, move, upload, download, and delete).
Download (files)
To download a file, issue a GET request against the download link. The response will have the Content-Disposition header set, which will will trigger a download in a browser.
Create Subfolder (folders)
You can create a subfolder of an existing folder by issuing a PUT request against the new_folder link. The ?kind=folder portion of the query parameter is already included in the new_folder link. The name of the new subfolder should be provided in the name query parameter. The response will contain a WaterButler folder entity. If a folder with that name already exists in the parent directory, the server will return a 409 Conflict error response.
Upload New File (folders)
To upload a file to a folder, issue a PUT request to the folder's upload link with the raw file data in the request body, and the kind and name query parameters set to 'file' and the desired name of the file. The response will contain a WaterButler file entity that describes the new file. If a file with the same name already exists in the folder, the server will return a 409 Conflict error response.
Update Existing File (file)
To update an existing file, issue a PUT request to the file's upload link with the raw file data in the request body and the kind query parameter set to "file". The update action will create a new version of the file. The response will contain a WaterButler file entity that describes the updated file.
Rename (files, folders)
To rename a file or folder, issue a POST request to the move link with the action body parameter set to "rename" and the rename body parameter set to the desired name. The response will contain either a folder entity or file entity with the new name.
Move & Copy (files, folders)
Move and copy actions both use the same request structure, a POST to the move url, but with different values for the action body parameters. The path parameter is also required and should be the OSF path attribute of the folder being written to. The rename and conflict parameters are optional. If you wish to change the name of the file or folder at its destination, set the rename parameter to the new name. The conflict param governs how name clashes are resolved. Possible values are replace and keep. replace is the default and will overwrite the file that already exists in the target folder. keep will attempt to keep both by adding a suffix to the new file's name until it no longer conflicts. The suffix will be ' (x)' where x is a increasing integer starting from 1. This behavior is intended to mimic that of the OS X Finder. The response will contain either a folder entity or file entity with the new name. Files and folders can also be moved between nodes and providers. The resource parameter is the id of the node under which the file/folder should be moved. It must agree with the path parameter, that is the path must identify a valid folder under the node identified by resource. Likewise, the provider parameter may be used to move the file/folder to another storage provider, but both the resource and path parameters must belong to a node and folder already extant on that provider. Both resource and provider default to the current node and providers. If a moved/copied file is overwriting an existing file, a 200 OK response will be returned. Otherwise, a 201 Created will be returned.
Delete (file, folders)
To delete a file or folder send a DELETE request to the delete link. Nothing will be returned in the response body.
nodes.nodesFilesRead

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 containing the representation of the requested file object, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesForksCreate

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 node, forming a network of nodes.
You might use a fork to copy another's work to build on and extend. For example, a professor may create an OSF project of materials for individual student use. Each student forks the project to have his or her own copy of the materials to start his/her own work.
When creating a fork, your fork will only contain public components of the current node and components for which you are a contributor. Private components that you do not have access to will not be forked.
Required
There are no required attributes when creating a fork, as all of the forked node's attributes will be copied from the current node.
The title field is optional, with the default title being "Fork of " prepended to the current node's title.
Returns
Returns a JSON object with a data key containing the complete srepresentation of the forked node, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesForksList

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.
Forking a project creates a copy of an existing node and all of its contents. The fork always points back to the original node, forming a network of nodes.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 forked nodes. If the current node has zero forked nodes, the data key will contain an empty array. Each resource in the array is a separate node object and contains the full representation of the forked node, meaning additional requests to the forked node's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
nodes.nodesIdentifiersList

List all identifiers associated with a given node.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of identifiers. Each resource in the array is a separate identifier object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g.
Identifiers may be filtered by their category e.g ark or doi.
nodes.nodesInstitutionsList

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 affilited institutions. Each resource in the array is a separate institution object.
The links key contains a dictionary of links that can be used for .
nodes.nodesLinkedNodesList

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. Each resource in the array is a separate node object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their title, category, description, public, registration, or tags. title, description, and category are string fields and will be filteres using simple substring matching. public, registration are boolean and can be filtered using truthy values, such as true, false, 0, 1. tags is an array of simple strings.
nodes.nodesList

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 view.
The returned nodes are sorted by their date_modified, with the most recently updated nodes appearing first.
Registrations cannot be accessed through this endpoint (use the endpoints instead).
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 nodes. Each resource in the array is a separate node object and contains the full representation of the node, meaning additional requests to a node's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, preprint, and contributors.
Most fields are string fields and will be filtered using simple substring matching. Public and preprint are boolean fields, and can be filtered using truthy values, such as true, false, 0 or 1. Note that quoting true or false in the query will cause the match to fail.
nodes.nodesLogsList

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 includes the logs of the specified node as well as the logs of that node's children to which the current user has read-only access.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 logs. Each resource in the array is a separate logs object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include logs that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their action, and date.
nodes.nodesNodeAddonUpdate

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 be updated with either a PUT or PATCH request. The external_account_id, enabled, and folder_id fields are mandatory in a PUT, and optional in PATCH. Non-string values will be accepted and stringified, however we make no promises about the stringification output.
To delete or deauthorize a node addon, issue a PUT with all fields set to null or False, or a PATCH with enabled set False.
Permissions
NodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes. Any users with write or admin access to the node are able to deauthorize an enabled addon, but only the addon authorizer is able to change the configuration (i.e. selected folder) of an already-configured NodeSettings entity.
Returns
Returns a JSON object with a data key containing the new representation of the updated node addon, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesPartialUpdate

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 with either a PUT or PATCH request. The title and category fields are mandatory in a PUT request, and optional in a PATCH.
Permissions
Only write contributors may update a node. Attempting to update a node for which you do not have write access will result in a 403 Forbidden response.
Returns
Returns a JSON object with a data key containing the new representation of the updated node, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesPreprintsList

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 first.
Note: This API endpoint is under active development, and is subject to change in the future.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 preprints. Each resource in the array is a separate preprint object.
The links key contains a dictionary of links that can be used for .
nodes.nodesProvidersList

List of all storage providers that are configured for this node
Users of the OSF may access their data on a that have integrations with the OSF. We call these providers. By default, every node has access to the OSF-provided storage but may use as many of the supported providers as desired.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of files. Each resource in the array is a separate file object.
The links key contains a dictionary of links that can be used for .
Note: In the OSF filesystem model, providers are treated as folders, but with special properties that distinguish them from regular folders. Every provider folder is considered a root folder, and may not be deleted through the regular file API.
nodes.nodesProvidersRead

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 file object, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesRead

Retrieves the details of a given node (project or component).
Permissions
Only project contributors may retrieve the details of a private node. Attempting to retreive a private node for which you are not a contributor will result in a 403 Forbidden response.
Authentication is not required to view the details of a public node, as public nodes give read-only access to everyone.
Returns
Returns a JSON object with a data key containing the representation of the requested node, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
nodes.nodesRegistrationsList

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 registrations. Each resource in the array is a separate registrations object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. .
Registrations may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, and contributors.
nodes.nodesViewOnlyLinksList

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. Each resource in the array is a view only link object.
The links key contains a dictionary of links that can be used for .
Permissions
View only links on a node, public or private, are readable and writeable only by users that are administrators on the node.
Filtering
You can optionally request that the response only include view only links that match your filters by utilizing the filter query parameter, e.g. .
View Only Links may be filtered based on their name, anonymous and date_created fields. Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.
nodes.nodesViewOnlyLinksRead

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 link, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Permissions
View only links on a node, public or private, are readable and writeable only by users that are administrators on the node.
nodes.nodesWikisList
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 representation of the wiki, meaning additional requests to an individual wiki's detail view are not necessary.
Note that if an anonymous view_only key is being used, the user relationship will not be exposed.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
Wiki pages can be filtered based on their name and date_modified fields.
- filter[name]=<Str> -- filter wiki pages by name
- filter[date_modified][comparison_operator]=YYYY-MM-DDTH:M:S -- filter wiki pages based on date modified.
Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.

preprintProviders.preprintProviderDetail

Retrieves the details of a preprint provider.

Returns

Returns a JSON object with a data key containing the representation of the requested preprint provider, if the request is successful.

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.

Acceptable Subjects Structure

Each preprint provider specifies acceptable subjects. subjects_acceptable is an array found in attributes. Subjects consist of general parent subjects (e.g., Engineering), more specific child subjects (e.g., Aerospace Engineering), and even more specific grandchild subjects (e.g., Aerodynamics and Fluid Mechanics). Subjects can only be nested 3 deep.

"subjects_acceptable": [    [        [            # Parent Subject:            # Architecture            "584240d954be81056ceca9e5",
            # Child Subject:            # Architectural Engineering            "584240da54be81056cecac87"        ],        # Include all Architectural Engineering's children:        true    ],    [        [            # Parent Subject:            # Engineering            "584240da54be81056cecaca9",
            # Child Subject:            # Aerospace Engineering            "584240db54be81056cecacd6",
            # Grandchild Subject:            # Aerodynamics and Fluid Mechanics            "584240da54be81056cecaa74"        ],        # All nestings 3 deep must be false        false    ]]

The above structure would allow Architecture, Architectural Engineering, all of Architectural Engineering's children, Engineering, Aerospace Engineering, and Aerodynamics and Fluid Mechanics.

"subjects_acceptable": [    [        [            # Parent Subject:            # Architecture            "584240d954be81056ceca9e5",
            # Child Subject:            # Architectural Engineering            "584240da54be81056cecac87"        ],        # Include all Architectural Engineering's children:        true    ],    [        [            # Parent Subject:            # Engineering            "584240da54be81056cecaca9",
            # Child Subject:            # Aerospace Engineering            "584240db54be81056cecacd6",
            # Grandchild Subject:            # Aerodynamics and Fluid Mechanics            "584240da54be81056cecaa74"        ],        # All nestings 3 deep must be false        false    ]]

preprintProviders.preprintProviderLicensesList

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 of 10 preprint providers. Each resource in the array is a separate preprint provider object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
preprintProviders.preprintProviderList

A paginated list of all preprint providers. The returned preprint providers are sorted by their creation date, with the most recent preprints appearing first.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 preprint providers. Each resource in the array is a separate preprint provider object.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include preprint providers that match your filters by utilizing the filter query parameter, e.g. .
Preprint Providers may be filtered by their id, name, and description
preprintProviders.preprintProvidersPreprintsList

A paginated list of preprints from the specified preprint provider. The returned preprints are sorted by their creation date, with the most recent preprints appearing first.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 preprints. Each resource in the array is a separate preprint object.
The links key contains a dictionary with keys that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
You can optionally request that the response only include preprints that match your filters by utilizing the filter query parameter, e.g. .
Preprints may be filtered by their id, is_published, date_created, date_modified, and provider.
preprintProviders.preprintProviderTaxonomiesList

A paginated list of the taxonomies for a preprint provider. The returned preprint providers taxonomies are sorted by their creation date, with the most recent preprints appearing first.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 preprint providers. Each resource in the array is a separate preprint provider object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
preprints.preprintsBibliographicContributorsList

A paginated list of the Preprint's Bibliographic Contributors, sorted by their index. Contributors are users who can make changes to the Preprint. Contributors with WRITE permissions may edit preprint details, and ADMIN Contributors may add or remove other Contributors.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Note that if an anonymous view_only key is being used to view the list of contributors, the user relationship will not be exposed and the contributor ID will be an empty string.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 contributors. Each resource in the array contains the full representation of the contributor, meaning additional requests to a contributor's detail view are not necessary. Additionally, the full representation of the user this contributor represents is automatically embedded within the data key of the response.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include contributors that match your filters by utilizing the filter query parameter, e.g. .
Contributors may be filtered by their bibliographic and permission attributes.
preprints.preprintsCitationList

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 for the preprint citation.
preprints.preprintsCitationRead

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 the requested style.
preprints.preprintsContributorRead

Retrieves the details of a contributor on this Preprint. Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Note that if an anonymous view_only key is being used to view the list of contributors, the user relationship will not be exposed and the contributor ID will be an empty string.
Returns
Returns a JSON object with a data key containing the representation of the requested contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
preprints.preprintsContributorsCreate

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 Preprint. Contributors with WRITE permissions may edit preprint details, and ADMIN Contributors may add or remove other Contributors.
Contributors are categorized as either "bibliographic" or "non-bibliographic" contributors. From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Permissions
Only project administrators can add contributors to a Preprint.
Required
A relationship object with a data key, containing the users type and valid user ID is required.
All attributes describing the relationship between the Preprint and the user are optional.
Returns
Returns a JSON object with a data key containing the representation of the new contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
preprints.preprintsContributorsList

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 permissions may edit preprint details, and ADMIN Contributors may add or remove other Contributors.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.
Note that if an anonymous view_only key is being used to view the list of Contributors, the user relationship will not be exposed and the Contributor ID will be an empty string.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 contributors. Each resource in the array contains the full representation of the contributor, meaning additional requests to a contributor's detail view are not necessary. Additionally, the full representation of the user this contributor represents is automatically embedded within the data key of the response.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include contributors that match your filters by utilizing the filter query parameter, e.g. .
Contributors may be filtered by their bibliographic and permission attributes.
preprints.preprintsCreate

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 the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes [blocked] to understand why this request may have failed.
preprints.preprintsList

A paginated list of preprints from all preprint providers. The returned preprints are sorted by their creation date, with the most recent preprints appearing first.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 preprints. Each resource in the array is a separate preprint object.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include preprints that match your filters by utilizing the filter query parameter, e.g. .
Preprints may be filtered by their id, is_published, date_created, date_modified, and provider.
preprints.preprintsPartialUpdate

Updates the specified preprint by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Returns
Returns a JSON object with a data key containing the new representation of the updated preprint, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes [blocked] to understand why this request may have failed.
preprints.preprintsRead

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 successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsChildrenList

A paginated list of children of a registration.
The list consists of the next level child registrations for the given registration. The returned registrations are sorted by their date_modified, with the most recently updated child registrations appearing first.
The list will include child registrations that are public, as well as child registrations that are private, if the authenticated user has permission to view them.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 child registrations. If the given registration has zero child registrations, the data key will contain an empty array. Each resource in the array is a separate registration object and contains the full representation of the child registration.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. .
Registrations may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, and contributors.
Most fields are string fields and will be filtered using simple substring matching. Public is a boolean field, and can be filtered using truthy values, such as true, false, 0 or 1. Note that quoting true or false in the query will cause the match to fail.
registrations.registrationsCitationRead

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 details necessary for the citation style.
registrations.registrationsCitationsList

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 array of up to 10 citation styles. Each resource in the array is a separate citation styles object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include citation styles that match your filters by utilizing the filter query parameter, e.g. .
Citation styles may be filtered by their id, title, short-title, and summary.
registrations.registrationsCommentsList

A paginated list of the registration's comments.
The returned comments are sorted by their creation date, with the most recent comments appearing first.
Permissions
Comments of public registrations are given read-only access to everyone.
If the comment-level is private, only registration contributors have permission to comment.
If the comment-level is public, any logged-in OSF user can comment.
Comments of private registrations are only visible to contributors and administrators on the registration.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of comment objects. Each resource in the array is a separate comment object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include comments that match your filters by utilizing the filter query parameter, e.g.
Comments may be filtered by their deleted, target, date_created, date_modified.
Most fields are string fields and will be filtered using simple substring matching. Deleted is a boolean field, and can be filtered using truthy values, such as true, false, 0 or 1. Note that quoting true or false in the query will cause the match to fail.
registrations.registrationsContributorsList

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 the registration or, in the case of private registration, have read access to the registration.
Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed in the contributors list on the OSF, while non-bibliographic contributors are not.
Note that if an anonymous view_only key is being used to view the list of contributors, the user relationship will not be exposed and the contributor ID will be an empty string.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 contributors. Each resource in the array contains the full representation of the contributor. Additionally, the full representation of the user this contributor represents is automatically embedded within the data key of the response.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include contributors that match your filters by utilizing the filter query parameter, e.g. .
Contributors may be filtered by their bibliographic and permission attributes.
registrations.registrationsContributorsRead

Retrieves the details of a contributor on this registration.
Returns
Returns a JSON object with a data key containing the representation of the requested contributor, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsFilesList

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 an array of files. Each resource in the array is a separate file object and contains the full representation of the file.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include files that match your filters by utilizing the filter query parameter, e.g.
Files may be filtered by id, name, node, kind, path, provider, size, and last_touched.
registrations.registrationsFilesRead

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 the requested registration file object, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsForksCreate

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 the original registration, forming a network of registrations.
You might use a fork to copy another's work to build on and extend. For example, a professor may create an OSF project of materials for individual student use. Each student forks the project to have his or her own copy of the materials to start his/her own work.
When creating a fork, your fork will only contain public components of the current registration and components for which you are a contributor. Private components that you do not have access to will not be forked.
Required
There are no required attributes when creating a fork, as all of the forked registration's attributes will be copied from the current registration.
The title field is optional, with the default title being "Fork of " prepended to the current registration's title.
Returns
Returns a JSON object with a data key containing the complete representation of the forked registration, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsForksList

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 registration creates a copy of an existing registration and all of its contents.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 forks. If the current registration has no fork, the data key will contain an empty array. Each resource in the array is a separate registration object and contains the full representation of the registration's fork.
The links key contains a dictionary of links that can be used for .
registrations.registrationsIdentifiersList

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 identifiers. Each resource in the array is a separate identifier object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g.
Identifiers may be filtered by their category e.g ark or doi.
registrations.registrationsInstitutionsList

A paginated list of institutions affiliated with the registration.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 affiliated institutions. Each resource in the array is a separate institution object.
The links key contains a dictionary of links that can be used for .
registrations.registrationsLinkedNodesList

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. Each resource in the array is a separate node object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their title, category, description, public, registration, or tags. title, description, and category are string fields and will be filteres using simple substring matching. public, registration are boolean and can be filtered using truthy values, such as true, false, 0, 1. tags is an array of simple strings.
registrations.registrationsList

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 to view.
Non-registered nodes cannot be accessed through this endpoint (use the endpoints instead).
Registrations
A registration on the OSF creates a frozen, time-stamped version of a project that cannot be edited or deleted. The original project can still be edited, while the registered version cannot.
Registrations can be made public immediately or embargoed for up to 4 years.
Withdrawals
Registrations cannot be deleted, but they can be withdrawn. Withdrawing a registration removes the content of the registration but leaves behind basic metadata. A withdrawn registration will display a limited subset of information, namely, title, description, date_created, date_registered, date_withdrawn, registration, withdrawn, withdrawal_justification, and registration supplement. All other fields will be displayed as null. Additionally, the only relationship that remains accesible for a withdrawn registration is the contributors. All other relationships will return a 403 Forbidden response.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 registrations. Each resource in the array is a separate registration object and contains the full representation of the registration, meaning additional requests to a registration's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. .
Registrations may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, and contributors.
registrations.registrationsLogsList

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 object containing data and links keys.
The data key contains an array of up to 10 logs. Each resource in the array is a separate logs object.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include logs that match your filters by utilizing the filter query parameter, e.g. .
Logs may be filtered by their action, and date.
registrations.registrationsPartialUpdate

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 that can be modified on a registration
Registrations can only be turned from private to public, not vice versa.
Permissions
Only project administrators may update a registration.
Returns
Returns a JSON object with a data key containing the new representation of the updated registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsProvidersList

A paginated list of storage providers enabled on the registration
Users of the OSF may access their data on a that have integrations with the OSF. We call these providers. By default, every node has access to the OSF-provided storage but may use as many of the supported providers as desired.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 files. Each resource in the array is a separate file object.
The links key contains a dictionary of links that can be used for .
Note: In the OSF filesystem model, providers are treated as folders, but with special properties that distinguish them from regular folders. Every provider folder is considered a root folder, and may not be deleted through the regular file API.
registrations.registrationsRead

Retrieve the details of a given registration.
Permissions
Only project contributors may retrieve the details of a registration that is embargoed, or has not yet been made public. Attempting to retrieve a private registration for which you are not a contributor will result in a 403 Forbidden response.
Authentication is not required to view the details of a public registration, as public registrations give read-only access to everyone.
Registrations
A registration on the OSF creates a frozen, time-stamped version of a project that cannot be edited or deleted. The original project can still be edited, while the registered version cannot.
Registrations can be made public immediately or embargoed for up to 4 years.
Withdrawals
Registrations cannot be deleted, but they can be withdrawn. Withdrawing a registration removes the content of the registration but leaves behind basic metadata. A withdrawn registration will display a limited subset of information, namely, title, description, date_created, date_registered, date_withdrawn, registration, withdrawn, withdrawal_justification, and registration supplement. All other fields will be displayed as null. Additionally, the only relationship that remains accesible for a withdrawn registration is the contributors. All other relationships will return a 403 Forbidden response.
Returns
Returns a JSON object with a data key containing the representation of the requested registration, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrations.registrationsViewOnlyLinksList

A paginated list of view only links created for this registration.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 view only links. Each resource in the array is a view only link object.
The links key contains a dictionary of links that can be used for .
Permissions
View only links on a registration, public or private, are readable and writeable only by users that are administrators on the registration.
Filtering
You can optionally request that the response only include view only links that match your filters by utilizing the filter query parameter, e.g. .
View Only Links may be filtered based on their name, anonymous and date_created fields. Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.
registrations.registrationsViewOnlyLinksRead

Retrieves the details of a view only link created from this registration.
Returns
Returns a JSON object with a data key containing the representation of the requested view only link, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Permissions
View only links on a registration, public or private, are readable and writeable only by users that are administrators on the registration.
registrations.registrationsWikisList
A paginated list of the registration's wiki pages
Returns
A list of all registration's current wiki page versions ordered by their date_modified. Each resource contains the full representation of the wiki, meaning additional requests to an individual wiki's detail view are not necessary.
If the request is unsuccessful, a JSON object with an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Filtering
Wiki pages can be filtered based on their name and date_modified fields.
- filter[name]=<Str> -- filter wiki pages by name
- filter[date_modified][comparison_operator]=YYYY-MM-DDTH:M:S -- filter wiki pages based on date modified.
Possible comparison operators include 'gt' (greater than), 'gte'(greater than or equal to), 'lt' (less than) and 'lte' (less than or equal to). The date must be in the format YYYY-MM-DD and the time is optional.
registrationSchemaBlocks.getSchemaResponsesSchemaResponseIdSchemaBlocksSchemaResponseBlockId

This 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 Schemas, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrationSchemaBlocks.schemaResponseBlocksRead

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 representation of the requested Registration Schemas, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrationSchemas.registrationSchemaRead

Retrieves the details of a given Registration Schema. Registration Schemas defines the desired supplemental information that should accompany be included in a Registration. Registration Schemas are Read-only to API users.
Returns
Returns a JSON object with a data key containing the representation of the requested Registration Schemas, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
registrationSchemas.registrationSchemasList

Retrieve a paginated list of all active Registration Schemas. Registration Schemas describe the supplemental questions that accompany a registration. Registration Schemas are read-only for API users.
Returns
Returns a JSON object containing data and links keys. The data key contains an array of 10 Registration Schemas. Each resource in the array is a separate Registration Schemas object. The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error.
schemaResponseActions.getSchemaResponsesSchemaResponseIdActionsSchemaResponseActionId

Retrieves 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 Actions, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponseActions.postSchemaResponsesSchemaResponseIdActions

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 containing the representation of the requested Schema Response Actions, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponseActions.schemaResponseActionRead

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 representation of the requested Schema Response Actions, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponses.schemaResponseDelete

This 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 approved it is immutable and another Schema Response must be created to update the Schema Response for that registration.
Returns
Returns a JSON object with a data key containing an updated representation of the requested Schema Response, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponses.schemaResponsePatch

Patching 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 in_progress state.
Returns
Returns a JSON object with a data key containing an updated representation of the requested Schema Response, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponses.schemaResponsePpost

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 state.
Returns
Returns a JSON object with a data key containing an updated representation of the requested Schema Response, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
schemaResponses.schemaResponsesList

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 contains an array of 10 Schema Responses. Each resource in the array is a separate Registration Schemas object. The links key contains a dictionary of links that can be used for .
Errors
This request should never return an error.
schemaResponses.schemaResponsesRead

This 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 Response, if the request is successful.
Errors
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
taxonomies.taxonomiesList

A paginated list of all . Note: this API endpoint is under active development, and is subject to change in the future.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of up to 10 taxonomies. Each resource in the array is a separate taxonomy object.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include taxonomies that match your filters by utilizing the filter query parameter, e.g. '.
Taxonomies may be filtered by their id, parents, and text.
taxonomies.taxonomiesRead

Retrieves the details of a taxonomy.
Returns
Returns a JSON object with a data key containing the representation of the requested taxonomy, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
users.usersAddonAccountsList

A paginated list of addon accounts authorized by this user.
Permissions
Addon accounts are visible only to the user that authorized the account.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of at most 10 addon account objects. Each resource in the array is a separate addon account object and contains the full representation of the addon account.
The links key contains a dictionary of links that can be used for .
users.usersAddonAccountsRead

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 with a data key containing the representation of the requested addon account, if the request was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
users.usersAddonsList

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 containing data and links keys.
The data key contains an array of up to 10 addons. Each resource in the array is a separate addon object.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Attempting to request the accounts for an addon that is not enabled will result in a 404 Not Found response.
users.usersAddonsRead

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 object with a data key containing the representation of the requested user addon, if the request was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
Attempting to request the accounts for an addon that is not enabled will result in a 404 Not Found response.
users.usersInstitutionsList

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 array of 10 institutions. Each resource in the array is a complete institution object and contains the full representation of the institution, meaning additional requests to a institution's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
users.usersList

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 first.
The subroute /users/me/ is a special endpoint that always points to the currently logged-in user.
Versioning
As of version 2.3, merged users will not be returned from this endpoint.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 users. Each resource in the array is a separate users object and contains the full representation of the user, meaning additional requests to a user's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
This request should never return an error.
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Users may be filtered by their id, full_name, given_name, middle_name, or family_name.
users.usersNodesList

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 appearing first.
If the user ID in the path is the same as the logged-in user, all nodes will be returned. Otherwise, only the user's public nodes will be returned.
User registrations are not available at this endpoint.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 nodes. Each resource in the array is a separate node object and contains the full representation of the node, meaning additional requests to a node's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include nodes that match your filters by utilizing the filter query parameter, e.g. .
Nodes may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, preprint, and contributors.
users.usersPartialUpdate

Updates a user by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged.
Users can be updated with either a PUT or PATCH request. The full_name field is mandatory in a PUT request, and optional in a PATCH.
Note: if you make a PUT/PATCH request to the /users/me/ endpoint, you must still provide your full user ID in the ID field of the request. We do not support using the me alias in request bodies at this time.
Returns
Returns a JSON object with a data key containing the new representation of the updated node, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
users.usersPreprintsList

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 first.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 preprints. Each resource in the array is a complete preprint object and contains the full representation of the preprint, meaning additional requests to a preprint's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include preprints that match your filters by utilizing the filter query parameter, e.g. .
Preprints may be filtered by their id, is_published, date_created, date_modified, and provider.
users.usersRead

Retrieves the details of a given users.
The returned information includes the user's bibliographic information and the date the user was registered.
Additionally, relationships to the list of institutions with which the user is affiliated, and to the list of nodes which the user contributes to (that the requesting user has permission to see) are returned.
If me is given as the user_id in the request path, the record of the currently logged-in user will be returned.
Returns
Returns a JSON object with a data key containing the representation of the requested user, if the request is successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
users.usersRegistrationsList

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 updated registrations appearing first.
If the user ID in the path is the same as the logged-in user, all registrations will be returned. Otherwise, only the user's public registrations will be returned.
User nodes are not available at this endpoint.
Returns
Returns a JSON object containing data and links keys.
The data key contains an array of 10 registrations. Each resource in the array is a separate registration object and contains the full representation of the registration, meaning additional requests to a registration's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
Filtering
You can optionally request that the response only include registrations that match your filters by utilizing the filter query parameter, e.g. .
Registrations may be filtered by their id, title, category, description, public, tags, date_created, date_modified, root, parent, and contributors.
viewOnlyLinks.viewOnlyLinksNodeList

The list of nodes which this view only link gives read-only access to.
Permissions
Only project administrators may retrieve the nodes of a view only link. Attempting to retrieve a view only link without appropriate permissions will result in a 403 Forbidden response.
Returns
Returns a JSON object containing data and links keys. The data key contains an array of up to 10 nodes. Each resource in the array is a separate node object and contains the full representation of the node, meaning additional requests to a node's detail view are not necessary.
The links key contains a dictionary of links that can be used for .
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
viewOnlyLinks.viewOnlyLinksRead

Retrieves details about a specific view only link.
Permissions
Only project administrators may retrieve the details of a view only link. Attempting to retrieve a view only link without appropriate permissions will result in a 403 Forbidden response.
Returns
Returns a JSON object with a data key containing the representation of the requested view only link, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
wikis.wikiContent

Retrieves the plaintext content of a wiki in markdown format.
Returns
Returns text/markdown of the wiki content itself. If the request is unsuccessful, plaintext with the error message will be displayed.
wikis.wikiRead

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 the attached node.
Returns
Returns a JSON object with a data key containing the representation of the requested wiki, if the request was successful.
If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the to understand why this request may have failed.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools

Tools (158)

Returns

Errors

Returns

Returns

Filtering

Errors

Returns

Errors

Permissions

Returns

Permissions

Returns

Errors

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Errors

Permissions

Returns

Errors

Permissions

Returns

Permissions

Returns

Returns

Returns

Returns

Permissions

Returns

Permissions

Required

Returns

Permissions

Required

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Permissions

Returns

Returns

Waterbutler API actions

Download (files)

Create Subfolder (folders)

Upload New File (folders)

Update Existing File (file)

Rename (files, folders)