OSF

OSF Users API

Users represent individual accounts within the OSF (Open Science Framework) platform. Each user account includes identifying information such as names, email addresses, profile details, and metadata about activity and affiliations. The Users endpoints provide access to user-related resources for profile display, updates, affiliation management, node contributions, and interaction with various OSF services. The Users API enables both read and write operations, allowing for: - **Retrieving user information**: Includes full name, bibliographic name parts (given, middle, family, suffix), timezone, locale, account status, and registration date. - **Updating user attributes**: Authenticated users can update certain profile fields such as name, locale, timezone, employment history, education, and social links. - **Managing relationships**: Users can access related resources such as their affiliated institutions, nodes they contribute to, registrations, preprints, groups, and more. - **Accessing nested resources**: Email addresses, settings, external identities, and export/download data. Certain fields and actions are restricted based on authentication and permission levels. For example: - Viewing a user's full profile or updating information requires authentication. - Some attributes and relationships (e.g., `emails`, `settings`) are only accessible to the current user. - Accessing deactivated or anonymized users may return limited metadata or result in error responses. User profiles also support structured fields for `employment` and `education` (e.g., `institution`, `title`, `dates`, `ongoing` `status`) and `social` (e.g., `GitHub`, `ORCID`, `Twitter`), which are validated and standardized for consistency and citation accuracy. These endpoints are fundamental for user discovery, personalization, and managing identity and reputation across the OSF ecosystem.

GitHub OpenAPI

Operations 28

GET /users/ List all users #
GET /users/{user_id}/ Retrieve a user #
PATCH /users/{user_id}/ Update a user #
GET /users/{user_id}/institutions/ List all institutions #
GET /users/{user_id}/nodes/ List all nodes #
GET /users/{user_id}/preprints/ List all preprints #
GET /users/{user_id}/registrations/ List all registrations #
GET /users/{user_id}/addons/ List all user addons #
GET /users/{user_id}/addons/{provider}/ Retrieve a user addon #
GET /users/{user_id}/addons/{provider}/accounts/ List all addon accounts #
GET /users/{user_id}/addons/{provider}/accounts/{account_id}/ Retrieve an addon account #
POST /users/{user_id}/claim/ Claim a User Account #
GET /users/{user_id}/draft_preprints/ List a User's Draft Preprints #
GET /users/{user_id}/draft_registrations/ List a User's Draft Registrations #
GET /users/{user_id}/relationships/institutions/ Retrieve a User's Institution Relationships #
DELETE /users/{user_id}/relationships/institutions/ Remove Institutions from a User's Affiliations #
GET /users/{user_id}/settings/ Retrieve a User's Settings #
PATCH /users/{user_id}/settings/ Update a User's Settings #
GET /users/{user_id}/settings/emails/ List User Email Addresses #
POST /users/{user_id}/settings/emails/ Add a New Email Address #
GET /users/{user_id}/settings/emails/{email_id}/ Retrieve a User's Email Address #
PATCH /users/{user_id}/settings/emails/{email_id}/ Update a User's Email Address #
DELETE /users/{user_id}/settings/emails/{email_id}/ Remove a User's Email Address #
POST /users/{user_id}/settings/export/ Request User Account Export #
GET /users/{user_id}/settings/identities/ List User External Identities #
GET /users/{user_id}/settings/identities/{identity_id} Retrieve a User's External Identity #
DELETE /users/{user_id}/settings/identities/{identity_id} Remove a User's External Identity #
POST /users/{user_id}/settings/password/ Change a User's Password #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/osf/openapi/osf-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osf:osf-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osf-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Users API
  description: This is the official documentation for the OSF (Open Science Framework) API v2.
  version: '2.0'
  termsOfService: https://osf.io/terms_of_use/
  contact:
    name: OSF Support Team
    email: support@osf.io
    url: https://help.osf.io/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://cdn.cos.io/media/images/cos_center_logo_small.original.png
    backgroundColor: transparent
servers:
- url: https://api.test.osf.io/v2
tags:


# --- truncated at 32 KB (213 KB total) ---
# Full source: https://artifacts.apis.io/osf/openapi/osf-users-api-openapi.yml