lookup
lookup the document(s) associated with a processId, bucketId, groupId, or projectId.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
Path parameters
a processId, bucketId, groupId, or projectId
Query parameters
The maximum number of returned documents. Accepts 1-100 with a default of 20.
Only documents with names that contain the filter string will be returned in the results.
The attribute to use to sort results
The document attribute that will be used to sort the results.
The order in which to sort results
The order in which to sort the results. A value for sort must also be set.
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.
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
Example response
{
"message": "The method you used is not supported for this query"
}