OSF APIv2 Documentation
Base URL:
Auth: unknown
Endpoints: 59
Reachable: unknown
CORS: unknown
https://api.test.osf.io/v2Auth: unknown
Endpoints: 59
Reachable: unknown
CORS: unknown
Links
Endpoints
| Method | Path | Summary | Auth | Last Status | Latency |
|---|---|---|---|---|---|
GET |
/ | Root | — | — | — |
GET |
/actions/ | Actions | — | — | — |
GET |
/addons/ | List all addons | — | — | — |
GET |
/citations/styles/ | List all citation styles | — | — | — |
GET |
/citations/styles/{style_id}/ | Retrieve a citation style | — | — | — |
GET |
/collections/ | List all Collections | — | — | — |
GET |
/collections/{collection_id}/ | Retrieve a Collection | — | — | — |
GET |
/collections/{collection_id}/collected_metadata/ | Retrieve a list of collected metadata for a collection | — | — | — |
GET |
/collections/{collection_id}/collected_metadata/{cgm_id} | Retrieve Specific Metadata 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 | — | — | — |
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}/linked_nodes | List All Linked Nodes for a Collection | — | — | — |
GET |
/collections/{collection_id}/linked_nodes/relationships/ | Give a Sparse List of Node Ids | — | — | — |
GET |
/collections/{collection_id}/linked_preprints/ | List All Linked Preprints for a Collection | — | — | — |
GET |
/collections/{collection_id}/linked_registrations/ | List All Linked Registrations for a Collection | — | — | — |
GET |
/collections/{collection_id}/linked_registrations/relationships/ | Give a Sparse List of Registrations Ids | — | — | — |
GET |
/comments/{comment_id}/ | Retrieve a comment | — | — | — |
GET |
/draft_registrations/ | Retrieve a list of Draft Registrations | — | — | — |
GET |
/draft_registrations/{draft_id}/ | Retrieve a Draft Registration | — | — | — |
GET |
/draft_registrations/{draft_id}/contributors/ | Retreive a list Contributors from a Draft Registration | — | — | — |
GET |
/draft_registrations/{draft_id}/contributors/{user_id}/ | Retreive a Contributor from a Draft Registration | — | — | — |
GET |
/draft_registrations/{draft_id}/institutions/ | Retrieve Institutions afilliated with a Draft Registration | — | — | — |
GET |
/draft_registrations/{draft_id}/subjects/ | Retrieve Subjects associated with a Draft Registration | — | — | — |
GET |
/files/{file_id}/ | Retrieve a file | — | — | — |
GET |
/files/{file_id}/versions/ | List all file versions | — | — | — |
GET |
/files/{file_id}/versions/{version_id}/ | Retrieve a file version | — | — | — |
GET |
/institutions/ | List all institutions | — | — | — |
GET |
/institutions/{institution_id}/ | Retrieve an institution | — | — | — |
GET |
/institutions/{institution_id}/nodes/ | List all affiliated nodes | — | — | — |
GET |
/institutions/{institution_id}/registrations/ | List all affiliated registrations | — | — | — |
GET |
/license/{license_id}/ | Retrieve a license | — | — | — |
GET |
/licenses/ | List all licenses | — | — | — |
GET |
/logs/{log_id}/ | Retrieve a log | — | — | — |
GET |
/nodes/ | List all nodes | — | — | — |
GET |
/nodes/{node_id}/ | Retrieve a node | — | — | — |
GET |
/nodes/{node_id}/addons/ | List all addons | — | — | — |
GET |
/nodes/{node_id}/addons/{provider}/ | Retrieve an addon | — | — | — |
GET |
/nodes/{node_id}/addons/{provider}/folders/ | List all addon folders | — | — | — |
GET |
/nodes/{node_id}/children/ | List all child nodes | — | — | — |
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 | — | — | — |
GET |
/nodes/{node_id}/contributors/ | List all contributors | — | — | — |
GET |
/nodes/{node_id}/contributors/{user_id}/ | Retrieve a contributor | — | — | — |
GET |
/nodes/{node_id}/draft_registrations/ | List all draft registrations | — | — | — |
GET |
/nodes/{node_id}/draft_registrations/{draft_id}/ | Retrieve 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}/forks/ | List all forks of this node | — | — | — |
GET |
/nodes/{node_id}/identifiers/ | List all identifiers | — | — | — |
GET |
/nodes/{node_id}/institutions/ | List all institutions | — | — | — |
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 | — | — | — |
GET |
/preprint_providers/ | List all preprint providers | — | — | — |
GET |
/preprint_providers/{preprint_provider_id}/ | Retrieve a preprint provider | — | — | — |
GET |
/preprint_providers/{preprint_provider_id}/licenses/ | List all licenses | — | — | — |
GET |
/preprint_providers/{preprint_provider_id}/preprints/ | List all preprints | — | — | — |
GET |
/preprint_providers/{preprint_provider_id}/taxonomies/ | List all taxonomies | — | — | — |
GET |
/preprints/ | List all preprints | — | — | — |
GET |
/preprints/{preprint_id}/ | Retrieve a preprint | — | — | — |
GET |
/preprints/{preprint_id}/bibliographic_contributors/ | List all Bibliographic Contributors | — | — | — |
GET |
/preprints/{preprint_id}/citation/ | Retrieve citation details | — | — | — |
GET |
/preprints/{preprint_id}/citation/{style_id}/ | Retrieve a styled citation | — | — | — |
GET |
/preprints/{preprint_id}/contributors/ | List all Contributors for a Preprint | — | — | — |
GET |
/preprints/{preprint_id}/contributors/{user_id}/ | Retrieve a contributor | — | — | — |
GET |
/registrations/ | List all registrations | — | — | — |
GET |
/registrations/{registration_id}/ | Retrieve a registration | — | — | — |
GET |
/registrations/{registration_id}/children/ | List all child registrations | — | — | — |
GET |
/registrations/{registration_id}/citations/ | List all citation styles | — | — | — |
GET |
/registrations/{registration_id}/citations/{citation_id}/ | Retrieve a citation | — | — | — |
GET |
/registrations/{registration_id}/comments/ | List all comments | — | — | — |
GET |
/registrations/{registration_id}/contributors/ | List all contributors | — | — | — |
GET |
/registrations/{registration_id}/contributors/{user_id}/ | Retrieve a contributor | — | — | — |
GET |
/registrations/{registration_id}/files/ | List all storage providers | — | — | — |
GET |
/registrations/{registration_id}/files/{provider}/ | List all files | — | — | — |
GET |
/registrations/{registration_id}/files/{provider}/{path}/ | Retrieve a file | — | — | — |
GET |
/registrations/{registration_id}/forks/ | List all forks | — | — | — |
GET |
/registrations/{registration_id}/identifiers/ | List all identifiers | — | — | — |
GET |
/registrations/{registration_id}/institutions/ | List all institutions | — | — | — |
GET |
/registrations/{registration_id}/linked_nodes/ | List all linked nodes | — | — | — |
GET |
/registrations/{registration_id}/logs/ | List all logs | — | — | — |
GET |
/registrations/{registration_id}/view_only_links/ | List all view only links | — | — | — |
GET |
/registrations/{registration_id}/view_only_links/{link_id}/ | Retrieve a view only link | — | — | — |
GET |
/registrations/{registration_id}/wikis/ | List all wikis | — | — | — |
GET |
/schema_responses/ | List all Schema Responses | — | — | — |
GET |
/schema_responses/{schema_response_id} | Retrieve a Schema Response | — | — | — |
GET |
/schema_responses/{schema_response_id}/actions/ | Retrieve a list of Schema Response Actions for a Schema Response | — | — | — |
GET |
/schema_responses/{schema_response_id}/actions/{schema_response_action_id} | A Schema Response Action from a Schema Response | — | — | — |
GET |
/schema_responses/{schema_response_id}/schema_blocks/ | Retrieve a list of Registration Schema Blocks for a Schema Response | — | — | — |
GET |
/schema_responses/{schema_response_id}/schema_blocks/{schema_response_block_id} | Retrieve a Registration Schema Block | — | — | — |
GET |
/schemas/registrations/ | Retrieve a list of Registration Schemas | — | — | — |
GET |
/schemas/registrations/{registration_schema_id} | Retrieve a Registration Schema | — | — | — |
GET |
/taxonomies/ | List all taxonomies | — | — | — |
GET |
/taxonomies/{taxonomy_id}/ | Retrieve a taxonomy | — | — | — |
GET |
/view_only_links/{link_id}/ | Retrieve a view only link | — | — | — |
GET |
/view_only_links/{link_id}/nodes/ | List all nodes | — | — | — |
GET |
/wikis/{wiki_id}/ | Retrieve a Wiki | — | — | — |
GET |
/wikis/{wiki_id}/content/ | Retrieve the Content of a Wiki | — | — | — |