List all documents in a table. | Scout

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 limit=1, 10 cursor="cursor", 11 query="query", 12 offset=1, 13 sort_by="sort_by", 14 )

1 { 2 "data": [ 3 { 4 "document_id": "string", 5 "created_by": { 6 "type": "user", 7 "details": { 8 "api_key": {} 9 } 10 }, 11 "last_updated_by": { 12 "type": "user", 13 "details": { 14 "api_key": {} 15 } 16 }, 17 "data": {}, 18 "document_data_id": "string", 19 "created_at": "2024-01-15T09:30:00Z", 20 "last_updated_at": "2024-01-15T09:30:00Z", 21 "revision_id": "string", 22 "job_id": "string", 23 "sync_id": "string", 24 "studio_row": false, 25 "cells": {} 26 } 27 ], 28 "next_cursor": "string", 29 "has_more": false, 30 "total_count": 0, 31 "documents_uploading": false 32 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

offsetintegerOptionalDefaults to 0

Offset to fetch next set of records

sort_bystring or nullOptional

Sort by field

Response

Successful Response

datalist of objects or null

next_cursorstring or null

has_moreboolean or nullDefaults to false

total_countinteger or nullDefaults to 0

documents_uploadingboolean or nullDefaults to false

Authentication

Path Parameters

Query Parameters

Response

Errors