Fetch all entries

GET

silo

entries

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries

{
  "created_at": "2018-01-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.",
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
          "id": "<string>",
          "meta": {},
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "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",
          "key": "service-id",
          "link_scope": "public",
          "link_url": "https://example.com/info",
          "ref": "<string>",
          "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>"
}

Query Parameters

folder

string

Folder to search within.

Example:

"invoices"

created_at

string

Date from which results are provided.

Example:

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

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.

Example:

20

Response

200 - application/json

created_at

string

Date from which results are provided.

Example:

"2018-01-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

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.

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

object

JSON envelope contents when specifically requested.

list.digest

object

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

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.

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

object[]

Additional meta fields associated with the entry.

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.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.ref

string

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

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

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

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"

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.

Versioning Search entries

curl --request GET \
  --url https://api.invopop.com/silo/v1/entries

{
  "created_at": "2018-01-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.",
          "entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
          "hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
          "id": "<string>",
          "meta": {},
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "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",
          "key": "service-id",
          "link_scope": "public",
          "link_url": "https://example.com/info",
          "ref": "<string>",
          "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>"
}

Introduction

API

Guides

Fetch all entries

Query Parameters

Response