# OSF Schema Responses API

**Canonical:** https://apis.io/apis/osf/osf-schema-responses-api/  
**Provider:** OSF — https://apis.io/providers/osf/  
**Base URL:** https://api.osf.io  
**Documentation:** https://developer.osf.io

OSF Schema Responses 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 Schema Responses. The published artifact set on APIs.io includes an OpenAPI specification.

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)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-schema-responses-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

Schema Responses

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/osf/osf-schema-responses-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/osf/.