v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Preprints

List all Contributors for a Preprint

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

Filtering

You can optionally request that the response only include contributors that match your filters by utilizing the filter query parameter, e.g. https://api.osf.io/v2/preprints/y9jdt/contributors/?filter[bibliographic]=true.

Contributors may be filtered by their bibliographic and permission attributes.

get/preprints/{preprint_id}/contributors/

Path parameters

preprint_idstring required

The unique identifier of the preprint.

Response

OK