---
title: "List linked documents"
method: GET
path: "/documents/{document}/linked-documents"
tags: ["Document Operations"]
---

# List linked documents

`GET /documents/{document}/linked-documents`

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

[Documents](/#documents) may be linked in various kinds of relationships. See the [Link
documents](/operations/v1.documents.linked-documents.store) 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.

## Path parameters

- `document` string, required

## Response `200`

Array of `DocumentRelationshipResource`

- object
  - `data` DocumentRelationshipResource[], required
    - `uuid` string, required
    - `controller_document` DocumentMinimalResource, required
      - `uuid` string, required
      - `name` string, required
      - `origin` 'signed_pdf' | 'signed_pdf_external_account' | 'template' | 'scratch' | 'onboarding' | 'pdf', required
      - `stage` 'draft' | 'approved_draft' | 'review' | 'approved_review' | 'signing' | 'done', required
      - `locale` string, nullable, required
      - `template_uuid` string, required — UUID of the [template](/#templates) the document was created from, if any
      - `created_at` string, date-time, nullable, required
      - `updated_at` string, date-time, nullable, required
      - `archived_at` string, date-time, nullable, required
      - `parties` DocumentPartySnippetResource[], required — The people and/or organizations that will be involved in signing the document
        - `uuid` string, required
        - `ref_uuid` string, required — If the document containing this party was created from a template, this identifier will be the same as the `ref_uuid` of the corresponding party in the source template.
        - `reference` string, nullable, required — A generic reference for the party
        - `entity_name` string, nullable, required — The actual name of the party. May be null if the party was created via a Template's "set later" option
        - `address` string, nullable, required
        - `scope` 'internal' | 'internal_and_external', required
        - `is_internal_party` boolean, required — Indicates whether this party is linked to an account party (internal) or is standalone (external)
        - `is_ready_for_signing` boolean, required — `true` indicates that an external party has indicated they are ready to sign
        - `ready_for_signing_at` string, date-time, nullable, required
        - `created_at` string, date-time, nullable, required
        - `updated_at` string, date-time, nullable, required
      - `links` object, required
        - `show` string, required — Link to [Show document](/operations/v1.documents.show)
        - `latest_revision_pdf` string, required — Link to [show latest revision PDF details](/operations/v1.documents.revisions.latest.pdf.show)
        - `latest_revision_pdf_download` string, required — Link to [download latest revision PDF](/operations/v1.documents.revisions.latest.pdf.download)
    - `peripheral_document` DocumentMinimalResource, required
      - `uuid` string, required
      - `name` string, required
      - `origin` 'signed_pdf' | 'signed_pdf_external_account' | 'template' | 'scratch' | 'onboarding' | 'pdf', required
      - `stage` 'draft' | 'approved_draft' | 'review' | 'approved_review' | 'signing' | 'done', required
      - `locale` string, nullable, required
      - `template_uuid` string, required — UUID of the [template](/#templates) the document was created from, if any
      - `created_at` string, date-time, nullable, required
      - `updated_at` string, date-time, nullable, required
      - `archived_at` string, date-time, nullable, required
      - `parties` DocumentPartySnippetResource[], required — The people and/or organizations that will be involved in signing the document
        - `uuid` string, required
        - `ref_uuid` string, required — If the document containing this party was created from a template, this identifier will be the same as the `ref_uuid` of the corresponding party in the source template.
        - `reference` string, nullable, required — A generic reference for the party
        - `entity_name` string, nullable, required — The actual name of the party. May be null if the party was created via a Template's "set later" option
        - `address` string, nullable, required
        - `scope` 'internal' | 'internal_and_external', required
        - `is_internal_party` boolean, required — Indicates whether this party is linked to an account party (internal) or is standalone (external)
        - `is_ready_for_signing` boolean, required — `true` indicates that an external party has indicated they are ready to sign
        - `ready_for_signing_at` string, date-time, nullable, required
        - `created_at` string, date-time, nullable, required
        - `updated_at` string, date-time, nullable, required
      - `links` object, required
        - `show` string, required — Link to [Show document](/operations/v1.documents.show)
        - `latest_revision_pdf` string, required — Link to [show latest revision PDF details](/operations/v1.documents.revisions.latest.pdf.show)
        - `latest_revision_pdf_download` string, required — Link to [download latest revision PDF](/operations/v1.documents.revisions.latest.pdf.download)
    - `relationship_type` 'parent' | 'amendment' | 'renewal' | 'addition' | 'replacement' | 'termination', required
    - `created_at` string, date-time, nullable, required

## Other responses

- `401` — Unauthenticated
- `403` — Authorization error
- `404` — Not found

---

[API](https://skmtc.dev/fynk/apis/fynk-api-reference.md) · [All operations](https://skmtc.dev/fynk/apis/fynk-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fynk/fynk-api-reference/revisions/9657a6757f59/schema)