list | Documentation

lookup all documents across all resources which are currently on GroundX

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

documentslist of objectsOptional

nextTokenstringOptional

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY",
5	)
6	client.documents.list()

1	{
2	"documents": [
3	{
4	"bucketId": 0,
5	"documentId": "documentId",
6	"fileName": "fileName",
7	"fileSize": "1.4MB",
8	"fileType": "bmp",
9	"processId": "processId",
10	"searchData": {},
11	"sourceUrl": "sourceUrl",
12	"status": "queued",
13	"statusMessage": "statusMessage",
14	"xrayUrl": "xrayUrl"
15	}
16	],
17	"nextToken": "nextToken"
18	}

Headers

Query parameters

Response