Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In order to get the list of all documents, send a GET request to the /documents resource. The response will contain contains a paginated list of all documents.

Request Query Parameters

Name

Type

Description

limit

number

(Optional) Maximum number of documents to return (default 20).

offset

number

(Optional) Starting offset (default 0).

Response

The response will contain contains a paginated list of documents.

Headers

Status Code

Description

200 (OK)

Operation is successful.

Body

The response entity has the following fields:

Name

Type

Description

documents

array

All documents of the current result page.