Create a table in a collection. | Scout API & SDK Reference

curl -X POST https://api.scoutos.com/v2/collections/collection_id/tables \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "table_config": {
      "table_display_name": "Customer Orders",
      "table_img_url": "https://example.com/images/customer_orders.png",
      "table_description": "Table containing customer order details including status and fulfillment.",
      "schema": [
        {
          "column_id": "order_status",
          "column_display_name": "Order Status",
          "column_type": "checkbox",
          "data_type": "boolean",
          "hidden": false,
          "automation_config": {
            "mode": "typescript",
            "button_text": "Update Status",
            "executing_text": "Updating...",
            "function": "updateOrderStatus"
          },
          "default": false
        }
      ],
      "icon_emoji": "📦",
      "icon_asset_url": "https://example.com/icons/package_icon.svg",
      "icon_fill": "#4A90E2",
      "plural_name": "Customer Orders"
    },
    "created_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "last_updated_by": {
      "type": "user",
      "details": {
        "api_key": {}
      }
    },
    "revision_id": "rev-20240115-001",
    "table_id": "tbl-9f8b7c6d",
    "index_id": "idx-3a2b1c4d",
    "created_at": "2024-01-15T09:30:00Z",
    "last_updated_at": "2024-01-15T09:30:00Z",
    "collection_id": "col-7e6f5d4c",
    "documents_uploading": false,
    "migrated": false,
    "agent_table_id": "agent-tbl-12345"
  }
}

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.

table_display_namestringOptionalDefaults to Untitled

table_img_urlstring or nullOptional

table_descriptionstring or nullOptional

schemalist of objects or nullOptional

icon_emojistring or nullOptional

icon_asset_urlstring or nullOptional

icon_fillstring or nullOptional

plural_namestring or nullOptional

table_idstring or nullOptional

Optional user-provided table ID. Must be a lowercase slug (a-z, 0-9, hyphens, underscores) between 3 and 63 characters. If omitted, an ID is auto-generated.

Response

Successful Response

dataobject or null

Errors

422

Unprocessable Entity Error