Find related entries

cURL

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries/{id}/related \
  --header 'Authorization: Bearer <token>'

{
  "created_at": "2025-05-01T00:00:00.000Z",
  "cursor": "<string>",
  "folder": "sales",
  "limit": 20,
  "list": [
    {
      "attachments": [
        {
          "created_at": "2018-01-01T00:00:00.000Z",
          "desc": "Invoice for January 2021.",
          "embeddable": true,
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
          "id": "<string>",
          "meta": {},
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "previous": [
            {
              "created_at": "2018-01-01T00:00:00.000Z",
              "hash": "<string>",
              "id": "<string>",
              "size": 123
            }
          ],
          "private": true,
          "size": 12345,
          "stored": true,
          "url": "<string>"
        }
      ],
      "context": "line.item",
      "created_at": "2018-01-01T00:00:00.000Z",
      "data": {},
      "digest": {
        "alg": "<string>",
        "val": "<string>"
      },
      "doc_schema": "https://gobl.org/draft-0/bill/invoice",
      "draft": true,
      "env_schema": "https://gobl.org/draft-0/envelope",
      "faults": [
        {
          "code": "<string>",
          "message": "<string>",
          "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,
          "owner_id": "<string>",
          "ref": "<string>",
          "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",
      "tags": [
        "<string>"
      ],
      "updated_at": "2018-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": "<string>"
}

GET

silo

entries

{id}

cURL

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries/{id}/related \
  --header 'Authorization: Bearer <token>'

{
  "created_at": "2025-05-01T00:00:00.000Z",
  "cursor": "<string>",
  "folder": "sales",
  "limit": 20,
  "list": [
    {
      "attachments": [
        {
          "created_at": "2018-01-01T00:00:00.000Z",
          "desc": "Invoice for January 2021.",
          "embeddable": true,
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
          "id": "<string>",
          "meta": {},
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "previous": [
            {
              "created_at": "2018-01-01T00:00:00.000Z",
              "hash": "<string>",
              "id": "<string>",
              "size": 123
            }
          ],
          "private": true,
          "size": 12345,
          "stored": true,
          "url": "<string>"
        }
      ],
      "context": "line.item",
      "created_at": "2018-01-01T00:00:00.000Z",
      "data": {},
      "digest": {
        "alg": "<string>",
        "val": "<string>"
      },
      "doc_schema": "https://gobl.org/draft-0/bill/invoice",
      "draft": true,
      "env_schema": "https://gobl.org/draft-0/envelope",
      "faults": [
        {
          "code": "<string>",
          "message": "<string>",
          "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,
          "owner_id": "<string>",
          "ref": "<string>",
          "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",
      "tags": [
        "<string>"
      ],
      "updated_at": "2018-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization

string

header

required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Path Parameters

string

required

Silo entry ID to find related entries for.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

Query Parameters

uuid

string

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

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

context

string

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

Example:

"line.item"

created_at

string

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

Example:

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

cursor

string

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

limit

integer

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

Example:

20

Response

200 - application/json

created_at

string

Date from which results are provided in descending order.

Example:

"2025-05-01T00:00:00.000Z"

cursor

string

Cursor used to identify the current page of results.

folder

string

Key for the folder

Example:

"sales"

limit

integer

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

Example:

20

list

List · object[] | null

Array of entries sorted by creation time in descending order.

Show child attributes

list.attachments

Attachments · object[]

List of attachments for this entry.

Show child attributes

list.attachments.created_at

string

The date and time this attachment was created.

Example:

"2018-01-01T00:00:00.000Z"

list.attachments.desc

string

Description of the file.

Example:

"Invoice for January 2021."

list.attachments.embeddable

boolean

When true, the attachment can be embedded inside another attachment, like a PDF.

Example:

true

list.attachments.entry_id

string

The UUID of the entry this attachment belongs to.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

list.attachments.hash

string

SHA256 hash of the file.

Example:

"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6"

list.attachments.id

string

The UUID that identifies the attachment.

list.attachments.meta

Meta · object

Any additional meta data about the attachment.

Show child attributes

list.attachments.meta.{key}

string

list.attachments.mime

string

MIME type of the file.

Example:

"application/pdf"

list.attachments.name

string

Name of the file.

Example:

"invoice.pdf"

list.attachments.previous

Previous · object[]

Set of previous versions of the attachment.

Show child attributes

list.attachments.previous.created_at

string

The date and time this attachment was created.

Example:

"2018-01-01T00:00:00.000Z"

list.attachments.previous.hash

string

The SHA256 of the attachment's contents.

list.attachments.previous.id

string

The UUID that identifies the attachment when it was originally uploaded.

list.attachments.previous.size

integer

Size of the attachment.

list.attachments.private

boolean

When true, the attachment will not have a public link.

list.attachments.size

integer

Size of the file in bytes.

Example:

12345

list.attachments.stored

boolean

When true, indicates that the file's contents have been uploaded successfully.

Example:

true

list.attachments.url

string

URL where the file's contents can be downloaded.

list.context

string

When entry provided within a related query, this is the context within the document.

Example:

"line.item"

list.created_at

string

The date and time the silo entry was created.

Example:

"2018-01-01T00:00:00.000Z"

list.data

Data · object

JSON envelope contents when specifically requested.

list.digest

object

Show child attributes

list.digest.alg

string

list.digest.val

string

list.doc_schema

string

Schema URL for the envelope's payload.

Example:

"https://gobl.org/draft-0/bill/invoice"

list.draft

boolean

Deprecated. When true, indicates that the envelope is not signed.

Example:

true

list.env_schema

string

Schema URL for the envelope.

Example:

"https://gobl.org/draft-0/envelope"

list.faults

Faults · object[]

List of faults that occurred during the processing of the job associated with the last state.

Show child attributes

list.faults.code

string

Code assigned by the provider that may provide additional information about the fault.

list.faults.message

string

Message assigned by the provider that may provide additional information about the fault.

list.faults.provider

string

ID of the provider that generated the fault.

Example:

"pdf"

list.folder

string

Key for the folder where the entry is located.

Example:

"sales"

list.id

string

UUID of the silo entry.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

list.invalid

boolean

When true, the envelope's contents are invalid and need to be reviewed.

Example:

true

list.key

string

Key used to identify the entry idempotently within a workspace.

Example:

"invoice-101"

list.meta

Meta · object[]

Additional meta fields associated with the entry.

Show child attributes

list.meta.created_at

string

Timestamp of when the row was created.

Example:

"2018-01-01T00:00:00.000Z"

list.meta.entry_id

string

ID of the entry this meta row belongs to

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002"

list.meta.id

string

Compound ID of the meta row.

Example:

"347c5b04-cde2-11ed-afa1-0242ac120002:source:key"

list.meta.indexed

boolean

When true, the meta entry is indexed for search.

Example:

true

list.meta.key

string

Key used to identify the meta entry by the source.

Example:

"service-id"

list.meta.link_scope

string

Describes the context in which the link should be made available.

Example:

"public"

list.meta.link_url

string

URL associated with the meta row that may be used to perform additional actions or view more details.

Example:

"https://example.com/info"

list.meta.owned

boolean

When true, the meta entry is indexed by owner ID.

Example:

true

list.meta.owner_id

string

UUID of the owner of the silo entry, typically a workspace ID. Included for reference when the authentication token does not already include the owner such as for lookups by reference.

list.meta.ref

string

Indexable value used to locate the meta entry if a silo entry ID is not available.

list.meta.secure

boolean

When true, the meta entry is never included in lists and needs to be specifically requested.

Example:

true

list.meta.shared

boolean

When true, the meta entry may be shared with other applications.

Example:

true

list.meta.src

string

The service or source that create this meta entry.

Example:

"source"

list.meta.updated_at

string

Timestamp of when the row was last updated.

Example:

"2018-01-01T00:00:00.000Z"

list.meta.value

Value · object

The JSON data stored with the meta row.

Example:

{ "key": "value" }

list.signed

boolean

When true, the envelope has been signed and should not be modified.

Example:

true

list.snippet

Snippet · object

JSON object containing a snippet of the document.

Example:

{ "title": "Sample Title" }

list.state

string

Current state of the silo entry if not a draft.

Example:

"sent"

list.tags

string[]

Copy of tags stored in the envelope header.

list.updated_at

string

The date and time the silo entry was last updated.

Example:

"2018-01-01T00:00:00.000Z"

next_cursor

string

Cursor used to identify the next page of results.

Update entry Fetch attachment

⌘I

API

Silo

Transform

Sequences

Access

Apps

Utils

Find related entries

Authorizations

Path Parameters

Query Parameters

Response