Users

Retrieve a User's Institution Relationships

Retrieves the relationships between a user and their affiliated institutions. Only the authenticated user can view their affiliated institutions in this relationship endpoint.

Returns

Returns a JSON object with a data key containing an array of institution relationship identifiers.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes.

get/users/{user_id}/relationships/institutions/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/users/{user_id}/relationships/institutions/
  • Auth
    none declared

Path parameters

user_idstring required

The unique identifier of the user. Example: abc123

Response

Successfully retrieved the user's affiliated institutions.

Example response

{
  "data": [
    {
      "id": "mit",
      "type": "institutions"
    }
  ]
}

Changes

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