Retrieve documents

Retrieve a paginated list of documents from an Ahoy Data Intelligence project.

API documentation: https://www.ahoyams.com/marketplace/cbe0812f-2def-46ec-a73c-788f97ff2c2a#description/introduction

Application

• Ahoy Data Intelligence

Inputs (what you have)

Name	Description	Data Type	Required?	Example
Project name	Name of the Ahoy Data Intelligence project whose documents should be listed	Text (Short)	Yes	Wrk Product Knowledge
Page	1-based page number. Defaults to 1	Number	No	1
Page size	Documents per page. Defaults to 20. Maximum: 100	Number	No	20

Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data Library section. These variables in the Data Library section are the outputs of previous Wrk Actions in the Wrkflow.

Outputs (what you get)

Name	Description	Data Type	Required?	Example
Documents	Stringified JSON array of document objects. Each item can contain id, filename, content_type, description, file_size, uploaded_at, processed, processing_status, and batch_id	Text (Long)	Yes	[{"id":"doc_456","filename":"SOP.pdf"}]
Total	Total documents across all pages	Number	Yes	245
Page	Current page	Number	Yes	1
Page size	Current page size	Number	Yes	100
Total pages	Total page count	Number	Yes	3
Provider message	Provider response message when returned	Text (Long)	No

Outcomes

Name	Description
Success	This status is selected if the job has successfully completed.

Requirements

• N/A