# OSF Collections API

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

OSF Collections 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 Collection. The published artifact set on APIs.io includes an OpenAPI specification.

The Collections API from OSF — 11 operation(s) for collections.

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/collections/` | List all Collections |
| POST | `/collections/` | Create a Collection |
| GET | `/collections/{collection_id}/` | Retrieve a Collection |
| DELETE | `/collections/{collection_id}/` | Delete a Collection |
| GET | `/collections/{collection_id}/linked_nodes` | List All Linked Nodes for a Collection |
| POST | `/collections/{collection_id}/linked_nodes/relationships/` | Link Nodes to Collection |
| GET | `/collections/{collection_id}/linked_nodes/relationships/` | Give a Sparse List of Node Ids |
| DELETE | `/collections/{collection_id}/linked_nodes/relationships/` | Remove Nodes From Collection |
| GET | `/collections/{collection_id}/linked_registrations/` | List All Linked Registrations for a Collection |
| POST | `/collections/{collection_id}/linked_registrations/relationships/` | Link Registrations to Collection |
| GET | `/collections/{collection_id}/linked_registrations/relationships/` | Give a Sparse List of Registrations Ids |
| DELETE | `/collections/{collection_id}/linked_registrations/relationships/` | Remove Registrations From Collection |
| GET | `/collections/{collection_id}/linked_preprints/` | List All Linked Preprints for a Collection |
| GET | `/collections/{collection_id}/collected_metadata/` | Retrieve a list of collected metadata for a collection |
| POST | `/collections/{collection_id}/collected_metadata/` | Add Metadata or Subjects to a Entity in a Collection |
| GET | `/collections/{collection_id}/collected_metadata/{cgm_id}` | Retrieve Specific Metadata for a Collection |
| POST | `/collections/{collection_id}/collected_metadata/{cgm_id}` | Add Metadata or Subjects to an Entity in a Collection |
| DELETE | `/collections/{collection_id}/collected_metadata/{cgm_id}` | Delete Collection Metadata from entitiy |
| GET | `/collections/{collection_id}/collected_metadata/{cgm_id}/subjects/` | Retrieve subject data for a specific piece of metadata info for a collection |
| GET | `/collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/` | Retrieve subject metadata for a specific piece of metadata in a collection |
| POST | `/collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/` | Update subjects for a specific piece of metadata in a collection |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-collections-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 Comments API](https://apis.io/apis/osf/osf-comments-api/)
- [OSF Contributors API](https://apis.io/apis/osf/osf-contributors-api/)
- [OSF Custom Metadata API](https://apis.io/apis/osf/osf-custom-metadata-api/)

## Tags

Collection

---

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