Collections

Retrieve a Collection

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 pagination.

get/collections/{collection_id}/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/collections/{collection_id}/
  • Auth
    none declared

Path parameters

collection_idstring required

A short id for that collection

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.