Find related entries

GET

silo

entries

{id}

Path Parameters

string

required

Silo entry ID to find related entries for.

Query Parameters

uuid

string

Document UUID to find relations for.

context

string

Context within a document for which the silo entry's UUID has been mentioned.

created_at

string

Date from which results are provided.

cursor

string

Position provided by the previous result's next_cursor property.

limit

integer

Maximum number of entries to show in a page of results.

Response

200 - application/json

created_at

string

Date from which results are provided.

cursor

string

Cursor used to identify the current page of results.

folder

string

Key for the folder

limit

integer

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

list

object[] | null

Array of entries.

list.attachments

object[]

List of attachments for this entry.

list.context

string

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

list.created_at

string

The date and time the silo entry was created.

list.data

object

JSON envelope contents when specifically requested.

list.digest

object

list.doc_schema

string

Schema URL for the envelope's payload.

list.draft

boolean

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

list.env_schema

string

Schema URL for the envelope.

list.faults

object[]

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

list.folder

string

Key for the folder where the entry is located.

list.id

string

UUID of the silo entry.

list.invalid

boolean

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

list.meta

object[]

Additional meta fields associated with the entry.

list.signed

boolean

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

list.snippet

object

JSON object containing a snippet of the document.

list.state

string

Current state of the silo entry if not a draft.

Copy of tags stored in the envelope header.

list.updated_at

string

The date and time the silo entry was last updated.

next_cursor

string

Cursor used to identify the next page of results.

Update an entry Build GOBL Document

Introduction

API

Guides

Find related entries

Path Parameters

Query Parameters

Response