API version:

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Could not find resource owner
401 Resource owner is not entitled
401 invalid_token
401 Must be authenticated.
401 Unauthorized application.
422 Bad input parameter. Error message should indicate which one and why.

Examples

GET /public/{version}/documents
200
{
  "documents": [],
  "meta": {
    "total_pages": 0
  }
}

Params

Param name Description
search
optional

A search token.

Validations:

  • Must be a String

template_id
optional

Documents from a specific template

Validations:

  • Must be a String

state
optional

The document state filter. Must be one of valid document states or comma seperated list of states. Valid document states are: draft, pending, executed, voided, expired, declined, editing

per_page
optional

The number of documents included per page. Max is 100.

page
optional

Specific page of results

Validations:

  • Must be a number.