Lists

Manage Lists

Create, list, inspect, summarize, and delete Lists through the API.

#Overview

Use these endpoints to manage the list itself before working with columns or rows.

#Endpoints

Endpoint Description
GET /v1/lists List available lists.
POST /v1/lists Create a list.
GET /v1/lists/{tableId} Get list metadata.
GET /v1/lists/{tableId}/summary Get list metadata with column and row summary data.
DELETE /v1/lists/{tableId} Delete a list.

#Authentication

Authorization: Bearer sk_your_api_key_here

API keys are tenant-level credentials. Provide the Bigmind userId to act as in write request bodies, or as userId in the query string for read and delete requests.

#Example: List Available Lists

curl "https://api.bigmind.ai/v1/lists?userId=usr_123" \
  -H "Authorization: Bearer sk_your_api_key_here"

#Example: Create a List

The create request accepts a list name, optional description, and optional source. If source is omitted, Bigmind creates a free-form list.

{
  "userId": "usr_123",
  "name": "Account review queue",
  "description": "Accounts waiting for research",
  "source": {
    "type": "entity-based",
    "entityType": "account"
  }
}
curl -X POST https://api.bigmind.ai/v1/lists \
  -H "Authorization: Bearer sk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "usr_123",
    "name": "Account review queue",
    "description": "Accounts waiting for research",
    "source": {
      "type": "entity-based",
      "entityType": "account"
    }
  }'

Supported Sources

{ "source": { "type": "free-form" } }
{ "source": { "type": "entity-based", "entityType": "account" } }
{ "source": { "type": "entity-based", "entityType": "contact" } }
{ "source": { "type": "entity-based", "entityType": "lead" } }
{ "source": { "type": "exploration" } }
{ "source": { "type": "crm", "base_entity": "accounts" } }

#Error Responses

Errors use the standard API response shape:

{
  "success": false,
  "error": "List not found or not accessible: tbl_123"
}
Updated 5/14/2026