Sign in

v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Actions

List Review Actions

Retrieve a list of review actions accessible to the authenticated user. Review actions document state transitions or user comments related specifically to reviewable resources, like preprints. Supports pagination and filtering by:

  • id
  • trigger
  • from_state
  • to_state
  • date_created
  • date_modified

Pagination follows the JSON:API pagination specification.

Permissions

  • User must be authenticated and have permissions to view actions associated with the respective resources.

Errors

If unsuccessful, returns an errors object. See Errors and Error Codes.

get/actions/reviews/

Query parameters

pageinteger

Page number of the results to fetch.

per_pageinteger

Number of actions per page.

filter[id]string

Filter by the unique ID of the review action.

filter[trigger]string

Filter by the trigger that initiated the action.

filter[from_state]string

Filter by the previous state of the resource.

filter[to_state]string

Filter by the new state of the resource.

filter[date_created]string

Filter by the creation date of the action.

filter[date_modified]string

Filter by the last modification date of the action.

Response

Successful retrieval of review actions.

Example response

{
  "data": [
    {
      "id": "abc123",
      "type": "review-actions",
      "attributes": {
        "trigger": "accept",
        "comment": "Approved after careful consideration.",
        "from_state": "pending",
        "to_state": "accepted",
        "date_created": "2024-01-01T00:00:00Z",
        "date_modified": "2024-01-01T01:00:00Z",
        "visible": true
      },
      "relationships": {
        "creator": {
          "links": {
            "related": {
              "href": "https://api.osf.io/v2/users/user456/",
              "meta": {}
            }
          },
          "data": {
            "id": "user456",
            "type": "users"
          }
        },
        "target": {
          "links": {
            "related": {
              "href": "https://api.osf.io/v2/preprints/preprint789/",
              "meta": {}
            }
          },
          "data": {
            "id": "preprint789",
            "type": "preprints"
          }
        },
        "provider": {
          "links": {
            "related": {
              "href": "https://api.osf.io/v2/providers/preprints/osf/",
              "meta": {}
            }
          },
          "data": {
            "id": "osf",
            "type": "preprint-providers"
          }
        }
      },
      "links": {
        "self": "https://api.osf.io/v2/actions/abc123/"
      }
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 10,
    "version": "2.20"
  },
  "links": {
    "self": "https://api.osf.io/v2/actions/reviews/",
    "next": "https://api.osf.io/v2/actions/reviews/?page=2",
    "prev": "https://api.osf.io/v2/actions/reviews/?page=1"
  }
}