Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Find silo entries whose document mentions the given entry's UUID.

get/silo/v1/entries/{id}/related

Path parameters

idstring required

Silo entry ID to find related entries for.

Example:347c5b04-cde2-11ed-afa1-0242ac120002

Silo entry ID to find related entries for.

Query parameters

uuidstring

The unique identifier of the document to find related entries for.

Example:347c5b04-cde2-11ed-afa1-0242ac120002

The unique identifier of the document to find related entries for.

contextstring

The specific context within a document where the silo entry's UUID is referenced.

Example:line.item

The specific context within a document where the silo entry's UUID is referenced.

created_atstring

The starting date and time for retrieving related entries in descending order, formatted as an ISO timestamp.

Example:2023-08-02T00:00:00.000Z

The starting date and time for retrieving related entries in descending order, formatted as an ISO timestamp.

cursorstring

The position marker from the previous result's next_cursor property, used for pagination.

The position marker from the previous result's next_cursor property, used for pagination.

limitinteger

The maximum number of related entries to return in a single page of results.

Example:20

The maximum number of related entries to return in a single page of results.

Response

OK

created_atstring

Starting date for results. Acts as the upper bound when descending (the default) or the lower bound when ascending.

cursorstring

Cursor used to identify the current page of results.

folderstring

Key for the folder

limitinteger

Maximum number of entries to show in a page of results, up to 100.

next_cursorstring

Cursor used to identify the next page of results.

Example response

{
  "created_at": "2025-05-01T00:00:00.000Z",
  "folder": "sales",
  "limit": 20,
  "list": [
    {
      "attachments": [
        {
          "category": "version",
          "created_at": "2018-01-01T00:00:00.000Z",
          "desc": "Invoice for January 2021.",
          "embeddable": true,
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
          "key": "pdf",
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "previous": [
            {
              "created_at": "2018-01-01T00:00:00.000Z"
            }
          ],
          "size": 12345,
          "stored": true
        }
      ],
      "context": "line.item",
      "created_at": "2018-01-01T00:00:00.000Z",
      "doc_schema": "https://gobl.org/draft-0/bill/invoice",
      "draft": true,
      "env_schema": "https://gobl.org/draft-0/envelope",
      "faults": [
        {
          "provider": "pdf"
        }
      ],
      "folder": "sales",
      "id": "347c5b04-cde2-11ed-afa1-0242ac120002",
      "invalid": true,
      "key": "invoice-101",
      "meta": [
        {
          "created_at": "2018-01-01T00:00:00.000Z",
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "id": "347c5b04-cde2-11ed-afa1-0242ac120002:source:key",
          "indexed": true,
          "key": "service-id",
          "link_scope": "public",
          "link_url": "https://example.com/info",
          "owned": true,
          "secure": true,
          "shared": true,
          "src": "source",
          "updated_at": "2018-01-01T00:00:00.000Z",
          "value": {
            "key": "value"
          }
        }
      ],
      "signed": true,
      "snippet": {
        "title": "Sample Title"
      },
      "state": "sent",
      "updated_at": "2018-01-01T00:00:00.000Z"
    }
  ]
}