Beta

Create a List

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/lists

Save a reviewed Business or Person List definition. A null rule creates an empty curated List. Saving never copies members or grants access. view.data_columns picks the List's columns, in order; left out, the List shows a column for every field its rule filters by.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Header Parameters

Idempotency-Key*string
Length8 <= length <= 200
SMB-Workspace-Id*string
Formatuuid

Request Body

application/json
  1. body
name*string
Length1 <= length <= 120
description?|
Defaultnull
definition*|
view?

Response Body

The existing resource or idempotent replay was returned.

application/json
  1. response
data*
request_id*string
action_receipt*
idempotent_replay*smb_v0_operations_create_list_request.__local.properties.body.__schema16
curl -X POST 'https://example.com/v1/lists' \  -H 'Idempotency-Key: stringst' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "definition": {    "schema_version": "smb.list.v1",    "subject_type": "business",    "rule": {      "kind": "field",      "field": "name",      "operator": "eq",      "value": "string"    }  }}'
{  "data": {    "id": "string",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",    "name": "string",    "description": "string",    "definition": {      "schema_version": "smb.list.v1",      "subject_type": "business",      "rule": {        "kind": "field",        "field": "name",        "operator": "eq",        "value": "string"      }    },    "version": -9007199254740991,    "lifecycle_status": "active",    "count": {      "status": "unknown",      "value": null,      "as_of": null,      "fewer_than": -9007199254740991    },    "columns": [      {        "column_id": "8f0515e3-00f6-4dd0-8153-321f1f40863d",        "name": "string",        "value_type": "text",        "position": 0,        "options": [          {            "id": "string",            "label": "string",            "color": "gray"          }        ]      }    ],    "view": {      "data_columns": [        "string"      ]    }  },  "request_id": "string",  "action_receipt": {    "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7",    "command_id": "7d510d78-7444-4252-aeac-9e473949661e",    "operation": "list.create",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  },  "idempotent_replay": true}