For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all tables in a collection.
      • POSTCreate a table in a collection.
      • GETGet a table by ID.
      • PUTUpdate a table by ID.
      • DELDelete a table by ID.
      • GETGet a tables schema by ID.
      • POSTSync a table with a list of documents.
LogoLogo
Scout DocsAccess Scout
EndpointsTables

List all tables in a collection.

Beta
GET
https://api.scoutos.com/v2/collections/:collection_id/tables
GET
/v2/collections/:collection_id/tables
$curl https://api.scoutos.com/v2/collections/collection_id/tables \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "table_config": {
5        "table_display_name": "Project Tasks",
6        "table_img_url": "https://example.com/images/project-tasks.png",
7        "table_description": "A table containing all tasks related to the current project.",
8        "schema": [
9          {
10            "column_id": "col-1234",
11            "column_display_name": "Completed",
12            "column_type": "checkbox",
13            "data_type": "boolean",
14            "hidden": false,
15            "automation_config": {
16              "mode": "typescript",
17              "button_text": "Mark Complete",
18              "executing_text": "Completing...",
19              "function": "function markComplete(row) { row.completed = true; }"
20            },
21            "default": false
22          }
23        ],
24        "icon_emoji": "🗂️",
25        "icon_asset_url": "https://example.com/icons/folder-icon.svg",
26        "icon_fill": "#4A90E2",
27        "plural_name": "Project Tasks"
28      },
29      "created_by": {
30        "type": "user",
31        "details": {
32          "api_key": {}
33        }
34      },
35      "last_updated_by": {
36        "type": "user",
37        "details": {
38          "api_key": {}
39        }
40      },
41      "revision_id": "rev-7890abcd",
42      "table_id": "tbl-5678efgh",
43      "index_id": "idx-1234ijkl",
44      "created_at": "2024-01-15T09:30:00Z",
45      "last_updated_at": "2024-04-10T14:45:00Z",
46      "collection_id": "col-9012mnop",
47      "documents_uploading": false,
48      "migrated": true,
49      "agent_table_id": "agent-tbl-3456qrst"
50    }
51  ]
52}
Was this page helpful?
Previous

Create a table in a collection.

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired

Response

Successful Response
datalist of objects or null

Errors

422
Unprocessable Entity Error