List all documents in a table.

Beta

GET

https://api.scoutos.com/v2/collections/:collection_id/tables/:table_id/documents

GET

/v2/collections/:collection_id/tables/:table_id/documents

$ curl https://api.scoutos.com/v2/collections/collection_id/tables/table_id/documents \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "created_by": {
6         "type": "user",
7         "details": {
8           "api_key": {
9             "key_id": "api_9876543210abcdef",
10             "owner": "jane.doe@example.com"
11           }
12         }
13       },
14       "last_updated_by": {
15         "type": "user",
16         "details": {
17           "api_key": {
18             "key_id": "api_1234567890abcdef",
19             "owner": "john.smith@example.com"
20           }
21         }
22       },
23       "data": {
24         "title": "Quarterly Financial Report",
25         "status": "approved",
26         "amount": 125000.75,
27         "department": "Finance"
28       },
29       "document_data_id": "dd123456-7890-4abc-def0-1234567890ab",
30       "created_at": "2024-01-15T09:30:00Z",
31       "last_updated_at": "2024-04-10T14:45:00Z",
32       "revision_id": "rev_20240410_001",
33       "job_id": "job_20240115_1001",
34       "sync_id": "sync_20240410_01",
35       "studio_row_id": "row_7890abcd1234ef56",
36       "cells": {
37         "A1": "Revenue",
38         "B1": 125000.75,
39         "C1": "USD"
40       }
41     }
42   ],
43   "next_cursor": "cursor_abcdef1234567890",
44   "has_more": true,
45   "total_count": 150,
46   "documents_uploading": false
47 }

curl https://api.scoutos.com/v2/collections/collection_id/tables/table_id/documents \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
      "created_by": {
        "type": "user",
        "details": {
          "api_key": {
            "key_id": "api_9876543210abcdef",
            "owner": "jane.doe@example.com"
          }
        }
      },
      "last_updated_by": {
        "type": "user",
        "details": {
          "api_key": {
            "key_id": "api_1234567890abcdef",
            "owner": "john.smith@example.com"
          }
        }
      },
      "data": {
        "title": "Quarterly Financial Report",
        "status": "approved",
        "amount": 125000.75,
        "department": "Finance"
      },
      "document_data_id": "dd123456-7890-4abc-def0-1234567890ab",
      "created_at": "2024-01-15T09:30:00Z",
      "last_updated_at": "2024-04-10T14:45:00Z",
      "revision_id": "rev_20240410_001",
      "job_id": "job_20240115_1001",
      "sync_id": "sync_20240410_01",
      "studio_row_id": "row_7890abcd1234ef56",
      "cells": {
        "A1": "Revenue",
        "B1": 125000.75,
        "C1": "USD"
      }
    }
  ],
  "next_cursor": "cursor_abcdef1234567890",
  "has_more": true,
  "total_count": 150,
  "documents_uploading": false
}

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

cursorstring or nullOptional

Cursor to fetch next set of records

querystring or nullOptional

Search query

offsetintegerOptionalDefaults to 0

Offset to fetch next set of records

sort_bystring or nullOptional

Sort by field

filter_columnstring or nullOptional

Column to filter by (column_id or column_display_name). Requires filter_value. Cannot be used with pagination, sorting or query.

filter_valuestring or nullOptional

Value to match on. No partial text matching. Requires filter_column. Cannot be used with pagination, sorting or query.

Response

Successful Response

datalist of objects or null

next_cursorstring or null

has_morebooleanDefaults to false

total_countintegerDefaults to 0

documents_uploadingbooleanDefaults to false

column_mappingmap from strings to nullable strings

Errors

422

Unprocessable Entity Error

$	curl https://api.scoutos.com/v2/collections/collection_id/tables/table_id/documents \
>	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5	"created_by": {
6	"type": "user",
7	"details": {
8	"api_key": {
9	"key_id": "api_9876543210abcdef",
10	"owner": "jane.doe@example.com"
11	}
12	}
13	},
14	"last_updated_by": {
15	"type": "user",
16	"details": {
17	"api_key": {
18	"key_id": "api_1234567890abcdef",
19	"owner": "john.smith@example.com"
20	}
21	}
22	},
23	"data": {
24	"title": "Quarterly Financial Report",
25	"status": "approved",
26	"amount": 125000.75,
27	"department": "Finance"
28	},
29	"document_data_id": "dd123456-7890-4abc-def0-1234567890ab",
30	"created_at": "2024-01-15T09:30:00Z",
31	"last_updated_at": "2024-04-10T14:45:00Z",
32	"revision_id": "rev_20240410_001",
33	"job_id": "job_20240115_1001",
34	"sync_id": "sync_20240410_01",
35	"studio_row_id": "row_7890abcd1234ef56",
36	"cells": {
37	"A1": "Revenue",
38	"B1": 125000.75,
39	"C1": "USD"
40	}
41	}
42	],
43	"next_cursor": "cursor_abcdef1234567890",
44	"has_more": true,
45	"total_count": 150,
46	"documents_uploading": false
47	}