Tool to retrieve a list of documents. Use when you need to fetch invoices, quotes, contracts, or packing slips with optional filtering and pagination.
qstringSearch query to filter documents.
sortstringSort order. Prefix with - for descending. Examples: created_at, -updated_at, number
fieldsstringComma-separated list of fields to include instead of defaults.
includestringComma-separated list of related resources to sideload. Options: order, lines, customer, company, tax_values
page_sizeintegerNumber of documents per page. If None, server default is used.
page_numberintegerPage number to retrieve, must be >= 1.
filter_statusstringFilter by document status.
filter_archivedbooleanFilter documents by archived status.
filter_order_idstringFilter documents by order ID.
filter_document_typestringFilter by document type (e.g., quote, contract, invoice, packing_slip).
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.