awork icon

awork

Automate your workflows with the awork API

Actions110

Document → Get All Documents

AI-generated

Summary

Retrieve all documents from the aWork account, optionally filtered and ordered by specific criteria.

Inputs

  • Return All — Boolean flag to specify whether to return all documents or up to a given limit.
  • Filter By — String to filter the documents by specific criteria using the aWork filtering syntax.
  • Order By — String to order the documents by a specific field and direction using the aWork ordering syntax.

Output shape

a list of document objects, each representing a document in the aWork system.

If 'Return All' is set to false, the number of returned documents is limited by the node or workflow configuration. Filtering and ordering parameters directly affect the returned documents as per aWork API specifications.

Examples

Example 1: Retrieve all documents without filters, returning all results

Set 'Return All' to true; leave 'Filter By' and 'Order By' empty.

Example 2: Retrieve a limited number of documents filtered by specific criteria and sorted by name ascending

Set 'Return All' to false; enter a filter string such as "Name eq 'Project Plan'"; set 'Order By' to "Name asc".

Links

Discussion