Documents

lookup

lookup the document(s) associated with a processId, bucketId, or groupId.

Path parameters

idintegerRequired
a processId, bucketId, or groupId

Headers

X-API-KeystringRequired

Query parameters

nintegerOptional

The maximum number of returned documents. Accepts 1-100 with a default of 20.

filterstringOptional
Only documents with names that contain the filter string will be returned in the results.
sortenumOptional
The document attribute that will be used to sort the results.
Allowed values:
sortOrderenumOptional
The order in which to sort the results. A value for sort must also be set.
Allowed values:
statusenumOptional
A status filter on the get documents query. If this value is set, then only documents with this status will be returned in the results.
nextTokenstringOptional
A token for pagination. If the number of documents for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n documents.

Response

Look up success
countinteger or null
The number of results returned in the current response
documentslist of objects or null
nextTokenstring or null
remaininginteger or null
The number of results that have not been returned yet. Will be null if there are no remaining results.
totalinteger or null
The total number of results found