# OSF Nodes API

**Canonical:** https://apis.io/apis/osf/osf-nodes-api/  
**Provider:** OSF — https://apis.io/providers/osf/  
**Base URL:** https://api.osf.io  
**Documentation:** https://developer.osf.io

OSF Nodes API is one of 41 APIs that [OSF](https://apis.io/providers/osf/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Node. The published artifact set on APIs.io includes an OpenAPI specification.

The Nodes API from OSF — 37 operation(s) for nodes.

## Operations (60 of 64)

| Method | Path | Summary |
|---|---|---|
| GET | `/nodes/` | List all nodes |
| POST | `/nodes/` | Create a node |
| GET | `/nodes/{node_id}/` | Retrieve a node |
| PATCH | `/nodes/{node_id}/` | Update a node |
| DELETE | `/nodes/{node_id}/` | Delete a node |
| GET | `/nodes/{node_id}/addons/` | List all addons |
| GET | `/nodes/{node_id}/addons/{provider}/folders/` | List all addon folders |
| GET | `/nodes/{node_id}/addons/{provider}/` | Retrieve an addon |
| PATCH | `/nodes/{node_id}/addons/{provider}/` | Update an addon |
| GET | `/nodes/{node_id}/children/` | List all child nodes |
| POST | `/nodes/{node_id}/children/` | Create a child node |
| GET | `/nodes/{node_id}/citation/` | Retrieve citation details |
| GET | `/nodes/{node_id}/citation/{style_id}/` | Retrieve a styled citation |
| GET | `/nodes/{node_id}/comments/` | List all comments |
| POST | `/nodes/{node_id}/comments/` | Create a comment |
| GET | `/nodes/{node_id}/contributors/` | List all contributors |
| POST | `/nodes/{node_id}/contributors/` | Create a contributor |
| GET | `/nodes/{node_id}/contributors/{user_id}/` | Retrieve a contributor |
| PATCH | `/nodes/{node_id}/contributors/{user_id}/` | Update a contributor |
| DELETE | `/nodes/{node_id}/contributors/{user_id}/` | Delete a contributor |
| GET | `/nodes/{node_id}/draft_registrations/` | List all draft registrations |
| POST | `/nodes/{node_id}/draft_registrations/` | Create a draft registration based on your current project Node |
| PATCH | `/nodes/{node_id}/draft_registrations/{draft_id}/` | Update a draft registration |
| DELETE | `/nodes/{node_id}/draft_registrations/{draft_id}/` | Delete a draft registration |
| GET | `/nodes/{node_id}/files/` | List all storage providers |
| GET | `/nodes/{node_id}/files/providers/{provider}/` | Retrieve a storage provider |
| GET | `/nodes/{node_id}/files/{provider}/` | List all node files |
| GET | `/nodes/{node_id}/files/{provider}/{path}/` | Retrieve a file |
| GET | `/nodes/{node_id}/identifiers/` | Retrieve Identifiers for a Node |
| POST | `/nodes/{node_id}/identifiers/` | Mint a New Identifier for a Node |
| GET | `/nodes/{node_id}/institutions/` | List all institutions |
| POST | `/nodes/{node_id}/forks/` | Create a fork of this node |
| GET | `/nodes/{node_id}/forks/` | List all forks of this node |
| GET | `/nodes/{node_id}/linked_nodes/` | List all linked nodes |
| GET | `/nodes/{node_id}/logs/` | List all logs |
| GET | `/nodes/{node_id}/preprints/` | List all preprints |
| GET | `/nodes/{node_id}/registrations/` | List all registrations |
| GET | `/nodes/{node_id}/view_only_links/` | List all view only links |
| GET | `/nodes/{node_id}/view_only_links/{link_id}/` | Retrieve a view only link |
| GET | `/nodes/{node_id}/wikis/` | List all wikis |
| POST | `/nodes/{node_id}/wikis/` | Create a Wiki |
| GET | `/nodes/{node_id}/linked_by_nodes/` | List Nodes Linking to a Node |
| GET | `/nodes/{node_id}/linked_by_registrations/` | List Registrations Linking to a Node |
| GET | `/nodes/{node_id}/relationships/institutions/` | Retrieve relationships between a Node and its affiliated Institutions |
| PATCH | `/nodes/{node_id}/relationships/institutions/` | Replace relationships between a Node and its affiliated Institutions |
| POST | `/nodes/{node_id}/relationships/institutions/` | Add relationships between a Node and Institutions |
| DELETE | `/nodes/{node_id}/relationships/institutions/` | Remove relationships between a Node and Institutions |
| GET | `/nodes/{node_id}/relationships/linked_nodes/` | Retrieve relationships between a Node and its linked Nodes |
| PATCH | `/nodes/{node_id}/relationships/linked_nodes/` | Replace relationships between a Node and its linked Nodes |
| POST | `/nodes/{node_id}/relationships/linked_nodes/` | Add relationships between a Node and linked Nodes |
| DELETE | `/nodes/{node_id}/relationships/linked_nodes/` | Remove relationships between a Node and linked Nodes |
| GET | `/nodes/{node_id}/relationships/linked_registrations/` | Retrieve relationships between a Node and its linked Registrations |
| PATCH | `/nodes/{node_id}/relationships/linked_registrations/` | Replace relationships between a Node and linked Registrations |
| POST | `/nodes/{node_id}/relationships/linked_registrations/` | Add relationships between a Node and linked Registrations |
| DELETE | `/nodes/{node_id}/relationships/linked_registrations/` | Remove relationships between a Node and linked Registrations |
| GET | `/nodes/{node_id}/relationships/subjects/` | Retrieve the relationships between a Node and its Subjects |
| PATCH | `/nodes/{node_id}/relationships/subjects/` | Update the relationships between a Node and its Subjects |
| POST | `/nodes/{node_id}/relationships/subjects/` | Add relationships between a Node and Subjects |
| DELETE | `/nodes/{node_id}/relationships/subjects/` | Remove relationships between a Node and Subjects |
| GET | `/nodes/{node_id}/requests/` | List Requests for a Node |

…and 4 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-nodes-api-openapi.yml

## Other OSF APIs (12)

- [OSF API](https://apis.io/apis/osf/osf-api/)
- [OSF Actions API](https://apis.io/apis/osf/osf-actions-api/)
- [OSF Applications API](https://apis.io/apis/osf/osf-applications-api/)
- [OSF Base API](https://apis.io/apis/osf/osf-base-api/)
- [OSF CEDAR Metadata API](https://apis.io/apis/osf/osf-cedar-metadata-api/)
- [OSF Citations API](https://apis.io/apis/osf/osf-citations-api/)
- [OSF Collection Providers API](https://apis.io/apis/osf/osf-collection-providers-api/)
- [OSF Collection Submission Actions API](https://apis.io/apis/osf/osf-collection-submission-actions-api/)
- [OSF Collection Submissions API](https://apis.io/apis/osf/osf-collection-submissions-api/)
- [OSF Collections API](https://apis.io/apis/osf/osf-collections-api/)
- [OSF Comments API](https://apis.io/apis/osf/osf-comments-api/)
- [OSF Contributors API](https://apis.io/apis/osf/osf-contributors-api/)

## Tags

Node

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/osf/osf-nodes-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/osf/.
