Document Operations

List linked documents

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

GET

/documents/{document}/linked-documents

curl --request GET \
  --url https://app.fynk.com/v1/api/documents/{document}/linked-documents \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "controller_document": {
        "archived_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "links": {
          "latest_revision_pdf": "https:...",
          "latest_revision_pdf_download": "https:...",
          "show": "https:..."
        },
        "locale": "de-AT",
        "name": "Kundenvertrag Muster GmbH",
        "origin": "signed_pdf",
        "parties": [
          {
            "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
            "created_at": "2023-11-07T05:31:56Z",
            "entity_name": "Demo Inc.",
            "is_internal_party": true,
            "is_ready_for_signing": true,
            "ready_for_signing_at": "2023-11-07T05:31:56Z",
            "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "reference": "Employer",
            "scope": "internal",
            "updated_at": "2023-11-07T05:31:56Z",
            "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
          }
        ],
        "stage": "draft",
        "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "peripheral_document": {
        "archived_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "links": {
          "latest_revision_pdf": "https:...",
          "latest_revision_pdf_download": "https:...",
          "show": "https:..."
        },
        "locale": "de-AT",
        "name": "Kundenvertrag Muster GmbH",
        "origin": "signed_pdf",
        "parties": [
          {
            "address": "1 Oxford Road\nHenley Bridge\nHB1 1PQ",
            "created_at": "2023-11-07T05:31:56Z",
            "entity_name": "Demo Inc.",
            "is_internal_party": true,
            "is_ready_for_signing": true,
            "ready_for_signing_at": "2023-11-07T05:31:56Z",
            "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "reference": "Employer",
            "scope": "internal",
            "updated_at": "2023-11-07T05:31:56Z",
            "uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f"
          }
        ],
        "stage": "draft",
        "template_uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "4df1e60a-0114-4dce-89e7-8c5ad397fcf2"
      },
      "relationship_type": "parent",
      "uuid": "c9872112-75dd-4d57-93ea-b8a305eabadb"
    }
  ]
}

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

Response

Array of DocumentRelationshipResource

dataobject[]required

Show child attributes

Still need help? Share an idea