v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Institutions

List all affiliated users

A paginated list of all users affiliated with an institution.

Returns

Returns a JSON object containing data and links keys.

The data key contains an array of 10 users. Each resource in the array is a separate users object.

The links key contains a dictionary of links that can be used for pagination.

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

Filtering

You can optionally request that the response only include users that match your filters by utilizing the filter query parameter, e.g. https://api.osf.io/v2/institutions/cos/users?filter[family_name]=Nosek.

Users may be filtered by their id, full_name, given_name, middle_names, and family_name

get/institutions/{institution_id}/users/

Path parameters

institution_idstring required

The unique identifier of the institution you wish to retrieve.

Response

OK