Searching for documents

Every managed document type has a GET endpoint to retrieve a filtered collection.

You can ask up to 30 documents per page and you can choose the number of items via the query parameter itemsPerPage You can switch page via the query parameter page.

To get information about the pagination you can send the HTTP header application/ld+json. You will receive an enriched payload containing the keys:

• hydra:member - the array with the retrieved item
• hydra:totalItems - total filtered item
• `hydra:view
  • hydra:first - URL to the first pag
  • hydra:last - URL to the last pag
  • hydra:next - URL to the next pag
• hydra:search - object containing information about the filters

See Hydra specifications for more information.

See the documentation to retrieve the collection of a resource for reference e.g. Invoices collection or Orders collection