# OSF Users API **Canonical:** https://apis.io/apis/osf/osf-users-api/ **Provider:** OSF — https://apis.io/providers/osf/ **Base URL:** https://api.osf.io **Documentation:** https://developer.osf.io OSF Users API is one of 41 APIs that [OSF](https://apis.io/providers/osf/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification. 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. ## Operations (28) | Method | Path | Summary | |---|---|---| | 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 | ## Machine-readable artifacts (1) - **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-users-api-openapi.yml ## Other OSF APIs (12) - [OSF API](https://apis.io/apis/osf/osf-api/) - [OSF Actions API](https://apis.io/apis/osf/osf-actions-api/) - [OSF Applications API](https://apis.io/apis/osf/osf-applications-api/) - [OSF Base API](https://apis.io/apis/osf/osf-base-api/) - [OSF CEDAR Metadata API](https://apis.io/apis/osf/osf-cedar-metadata-api/) - [OSF Citations API](https://apis.io/apis/osf/osf-citations-api/) - [OSF Collection Providers API](https://apis.io/apis/osf/osf-collection-providers-api/) - [OSF Collection Submission Actions API](https://apis.io/apis/osf/osf-collection-submission-actions-api/) - [OSF Collection Submissions API](https://apis.io/apis/osf/osf-collection-submissions-api/) - [OSF Collections API](https://apis.io/apis/osf/osf-collections-api/) - [OSF Comments API](https://apis.io/apis/osf/osf-comments-api/) - [OSF Contributors API](https://apis.io/apis/osf/osf-contributors-api/) ## Tags User --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/osf/osf-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/osf/.