OSF

OSF Schema Responses API

Schema Responses contain user supplied responses to a Registration Schema. A Schema Response aggregates all of the the responses for a given version of a Registration's Registration Schema. Schema Responses are created when a Registration is completed. Once a Registration is completed the Schema Responses for a Registration can be revisied and updated by using it's associated action endpoints. There are a few states for Schema Responses: - `initial` is the state of a Schema Response on a newly registered Registration, to edit a Schema Response you must create a Schema Response Action that triggers a new submission. - `in_progess` is the state of a Schema Response where the response is editable and still private, Schema Responses are editted via a PATCH request as specified below. - `unapproved` is the state of a Schema Response where edits have been made and "locked-in", now contributors have the ability to reject the changes, however if they are not rejected changes are automatically approved after 48 hours. If `unapproved` Schema Responses are rejected, they are returned to the `in_progress` state. If `unapproved` Schema Responses are approved they either enter an `approved` state or go into a `pending_moderation` to be accepted or denied by a moderator. - `pending_moderation` is the state of a Schema Response where moderators have an opportunity to reject or approve a Schema Response that has been approved by it's contributors. This state is only reachable for Schema Responses that are associated with a Registration that has Registration Provider a moderated workflow. - `approved` is the state of a Schema Response where it is public and immutable, in order to update an approved Schema Response a new one must be created.

Operations 5

GET /schema_responses/ List all Schema Responses #
POST /schema_responses/ Create a new Schema Response #
GET /schema_responses/{schema_response_id} Retrieve a Schema Response #
PATCH /schema_responses/{schema_response_id} Update a Registration's Schema Response #
DELETE /schema_responses/{schema_response_id} Delete a Incomplete Schema Response #

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-schema-responses-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.

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

OpenAPI Specification

osf-schema-responses-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Schema Responses 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 (47 KB total) ---
# Full source: https://artifacts.apis.io/osf/openapi/osf-schema-responses-api-openapi.yml