v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Registrations
Collection Submissions

List Submissions for a Registration

Retrieve a list of submissions associated with a specific registration. A submission represents an attempt to add a registration to a collection, typically requiring moderation or approval.

Permissions - Only authenticated users with access to the registration can view submission data. - Access to submission details may depend on the moderation settings of the related collections.

Returns - A JSON object with a data key containing an array of submission objects. - Each submission reflects its current moderation status and relevant metadata.

get/providers/registrations/{provider_id}/submissions/

Path parameters

provider_idstring required

The unique identifier of the registration.

Query parameters

filter[state]string

Filter submissions by their state. Available values:

  • in_progress
  • pending
  • accepted
  • rejected
  • removed
pageinteger

Page number of results to return (pagination).

per_pageinteger

Number of results per page (default 10, maximum 100).

Response

Successful retrieval of the list of submissions for the registration.

Example response

{
  "data": [
    {
      "id": "sub1",
      "type": "collection-submissions",
      "attributes": {
        "state": "pending",
        "date_submitted": "2024-12-01T12:00:00Z"
      },
      "relationships": {
        "collection": {
          "data": {
            "type": "collections",
            "id": "col123"
          }
        },
        "creator": {
          "data": {
            "type": "users",
            "id": "user456"
          }
        }
      },
      "links": {
        "self": "https://api.test.osf.io/v2/collection_submissions/sub1/"
      }
    }
  ]
}