Skip to main content

Document Links

Get all entity links for a specific document showing entity values, types, link keys, and linked document IDs.

GET/v1/linking/documents/{id}/links

Response

Response fields

dataarrayArray of entity link objects.
data[].entity_idstringEntity UUID.
data[].entity_valuestringRaw entity value shared across documents.
data[].link_key_categorystring | nullLink key category: identity, transaction, or reference.
data[].field_keystringField name where this entity value was extracted.
data[].document_countintegerNumber of documents sharing this entity value.

Response

{
  "data": [
    {
      "entity_id": "ent_uuid_1",
      "entity_value": "ACME-001",
      "link_key_category": "identity",
      "field_key": "vendor_id",
      "document_count": 5
    },
    {
      "entity_id": "ent_uuid_2",
      "entity_value": "PO-2024-001",
      "link_key_category": "transaction",
      "field_key": "po_number",
      "document_count": 2
    }
  ]
}

Errors

Error responses

400validation_errorInvalid document ID format. Must be a UUID.
401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Full Graph
Link Keys