List all documents in a table.

1 from scoutos import Scout 2 3 client = Scout( 4 api_key="YOUR_API_KEY", 5 ) 6 client.documents.list( 7 collection_id="collection_id", 8 table_id="table_id", 9 )

1 { 2 "data": [ 3 { 4 "document_id": "document_id", 5 "data": {}, 6 "document_data_id": "document_data_id", 7 "created_at": "created_at", 8 "last_updated_at": "last_updated_at", 9 "created_by": { 10 "type": "user", 11 "details": { 12 "user_id": "user_id", 13 "org_id": "org_id", 14 "scout_organization_id": "scout_organization_id", 15 "email": {} 16 } 17 }, 18 "last_updated_by": { 19 "type": "user", 20 "details": { 21 "user_id": "user_id", 22 "org_id": "org_id", 23 "scout_organization_id": "scout_organization_id", 24 "email": {} 25 } 26 }, 27 "revision_id": "revision_id" 28 } 29 ], 30 "next_cursor": "next_cursor", 31 "has_more": false, 32 "total_count": 0 33 }

Path parameters

collection_idstringRequired

table_idstringRequired

Query parameters

limitintegerOptionalDefaults to 50

Limit of records to return

cursorstringOptional

Cursor to fetch next set of records

querystringOptional

Search query

Response

Successful Response

datalist of objects or null

next_cursorstring or null

has_moreboolean or nullDefaults to false

total_countinteger or nullDefaults to 0

Path parameters

Headers

Query parameters

Response

Errors