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 "created_by": { 5 "type": "user", 6 "details": { 7 "user_id": "user_id", 8 "org_id": "org_id", 9 "scout_organization_id": "scout_organization_id", 10 "email": { 11 "key": "value" 12 } 13 } 14 }, 15 "last_updated_by": { 16 "type": "user", 17 "details": { 18 "user_id": "user_id", 19 "org_id": "org_id", 20 "scout_organization_id": "scout_organization_id", 21 "email": { 22 "key": "value" 23 } 24 } 25 }, 26 "document_id": "document_id", 27 "document_data_id": "document_data_id", 28 "created_at": "2024-01-15T09:30:00Z", 29 "last_updated_at": "2024-01-15T09:30:00Z", 30 "revision_id": "revision_id" 31 } 32 ], 33 "next_cursor": "next_cursor", 34 "has_more": true, 35 "total_count": 1 36 }

Path parameters

collection_idstringRequired

table_idstringRequired

Query parameters

limitintegerOptional

Limit of records to return

cursorstringOptional

Cursor to fetch next set of records

Response

Successful Response

datalist of objectsOptional

next_cursorstringOptional

has_morebooleanOptional

total_countintegerOptionalDefaults to 0

Path parameters

Headers

Query parameters

Response

Errors