OSosf
Registrations

List Linked By Registrations

Changed on

Retrieve a list of registrations that have added the specified registration as a node link. This allows you to discover which registrations are referencing the given registration through their node links.

Permissions

  • Public registrations expose their linked by registrations publicly.
  • Private registrations require read access to view this relationship.

Returns

  • A JSON object containing a data array of registration resources that link to this registration.
get/registrations/{registration_id}/linked_by_registrations/

Request

Path parameters

registration_idstring required

The unique identifier of the registration.

Response

Successful retrieval of registrations linking to the specified registration.

Example response

{
  "data": [
    {
      "id": "abcde",
      "type": "registrations",
      "attributes": {
        "title": "My Registration",
        "description": "This is a test registration.",
        "date_created": "2024-01-01T00:00:00Z",
        "public": true
      },
      "links": {
        "self": "https://api.osf.io/v2/registrations/abcde/"
      }
    }
  ],
  "links": {
    "self": "https://api.osf.io/v2/registrations/{registration_id}/linked_by_registrations/",
    "first": "https://api.osf.io/v2/registrations/{registration_id}/linked_by_registrations/?page=1",
    "last": "https://api.osf.io/v2/registrations/{registration_id}/linked_by_registrations/?page=1"
  },
  "meta": {
    "total": 1,
    "per_page": 10
  }
}

Changes