Skip to main content

List all documents

GET 

/documents

List all documents ordered by created_at descending.

Request

Query Parameters

    filter[filename][contains] string

    Filter by string matching part of filename.

    filter[customer_reference][eq] string

    Filter documents by a customer references.

    filter[customer_reference][in][] string

    Filter documents by a list of customer references.

    filter[created_at][gt] string

    Filter by created at greater than provided value.

    filter[created_at][lt] string

    Filter by created at less than provided value.

    sort[] string

    Possible values: [filename, created_at, updated_at]

    Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a - in front of the field name.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses

200: Successful response

Schema

    data object[]

    meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...