v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

List linked documents

<small>Requires an API token with the Document Reader role.</small>

Documents may be linked in various kinds of relationships. See the Link documents documentation for an overview of the possible types of relationship.

This endpoint returns the currently configured relationships between the document specified by the URL and any other documents.

get/documents/{document}/linked-documents

Path parameters

documentstring required

The document UUID

Response

Array of DocumentRelationshipResource

Example response

{
  "data": [
    {
      "uuid": "c9872112-75dd-4d57-93ea-b8a305eabadb",
      "controller_document": {
        "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "name": "Kundenvertrag Muster GmbH",
        "locale": "de-AT",
        "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "parties": [
          {
            "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
            "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "reference": "Employer",
            "entity_name": "Demo Inc.",
            "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
          }
        ],
        "links": {
          "show": "https:...",
          "latest_revision_pdf": "https:...",
          "latest_revision_pdf_download": "https:..."
        }
      },
      "peripheral_document": {
        "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "name": "Kundenvertrag Muster GmbH",
        "locale": "de-AT",
        "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "parties": [
          {
            "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
            "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "reference": "Employer",
            "entity_name": "Demo Inc.",
            "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ"
          }
        ],
        "links": {
          "show": "https:...",
          "latest_revision_pdf": "https:...",
          "latest_revision_pdf_download": "https:..."
        }
      }
    }
  ]
}