# OSF Actions API

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

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

Actions represent state transitions or comments performed on reviewable or request-related resources within the OSF platform, such as Preprints, Nodes, Preprint Requests, Node Requests, and Collection Submissions. These endpoints document and facilitate moderation and administrative workflows, ensuring transparency and accountability in managing user interactions, moderation processes, and lifecycle management for various resources. Actions are categorized based on their targets: - **Review Actions**: Pertaining to moderation and review processes on Preprints. - **Node Request Actions**: Related to Node Requests (e.g., access or withdrawal requests). - **Preprint Request Actions**: Related to Preprint Requests, such as withdrawal requests. Actions require specific permissions depending on their triggers: - `submit`: Typically open, no special permissions required. - `accept`/`reject`: Require moderation or admin permissions. - `edit_comment`: Requires administrative permissions. Each successful action response returns a JSON:API formatted object containing: - **id** : The identifier of the action. - **type** : Type of action performed (e.g., `review-actions`, `node-request-actions`). - **attributes** : Information including `trigger`, `comment`, `from_state`, `to_state`, timestamps (`date_created`, `date_modified`), visibility (`visible`), and automation flag (`auto`). - **relationships** : - `creator`: User who initiated the action. - `target` : The resource the action applies to (e.g., Preprint, Node Request). - `provider` : Provider associated with the target, if applicable. Actions may fail due to various reasons, resulting in standard error responses: - `400 Bad Request`: Invalid or malformed payload. - `403 Forbidden`: Insufficient permissions to perform the action. - `404 Not Found`: The target resource does not exist or is inaccessible. - `409 Conflict`: Invalid action due to the current state of the target resource.

## Operations (4)

| Method | Path | Summary |
|---|---|---|
| GET | `/actions/reviews/` | List Review Actions |
| POST | `/actions/requests/nodes/` | Create a Node Request Action |
| POST | `/actions/requests/preprints/` | Create a Preprint Request Action |
| GET | `/actions/{action_id}/` | Retrieve an Action by ID |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-actions-api-openapi.yml

## Other OSF APIs (12)

- [OSF API](https://apis.io/apis/osf/osf-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/)
- [OSF Custom Metadata API](https://apis.io/apis/osf/osf-custom-metadata-api/)

## Tags

Actions

---

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