Skip to main content

Search documents

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

You get 30 documents per page by default, and up to 100 with the query parameter itemsPerPage. You can switch page via the query parameter page.

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

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

See Hydra specifications for more information.

See the documentation to retrieve the collection of resources for reference e.g. Invoices collection