Beta

Unlock List columns

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/lists/{list_id}/unlock

Pay once to see paid columns for every member of a List, for 12 months in this Workspace. Charges each member x column with a value not yet unlocked; free columns, empty values and the first 5 members cost nothing. Up to 500 members a call (next_cursor). Returns usage (credits_charged, credits_remaining; 1,000,000 = $1.00). max_credits caps the charge: over it, nothing is charged (budget_exceeded).

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

list_id*string
Match^list_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

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

Request Body

application/json
  1. body
fields*array<>

SMB data columns to unlock, at most 30 per call: unlock more with another call.

Items1 <= items <= 30
after?string

next_cursor from the previous answer.

Length1 <= length <= 4096
max_credits?SmbV0OperationsGetBusinessRequestMaxCredits

Optional cap on the credits this call may charge (1,000,000 = $1.00). If it would cost more, nothing is charged and the call fails with budget_exceeded, saying how many credits it needs.

Range0 <= value <= 100000000

Response Body

Successful authorized response.

application/json
  1. response
data*
request_id*string
usage?

Credits this call used, from the same transaction as any charge. 1,000,000 credits = $1.00. Paid fields cost credits only when a value comes back that this Workspace hasn't unlocked; an unlock lasts 12 months.

action_receipt*
idempotent_replay*smb_v0_operations_create_list_request.__local.properties.body.__schema16
curl -X POST 'https://example.com/v1/lists/string/unlock' \  -H 'Idempotency-Key: stringst' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "fields": [    "string"  ]}'
{  "data": {    "list_id": "string",    "list_version": 1,    "fields": [      "string"    ],    "businesses": 0,    "credits": 0,    "expires_at": "2019-08-24T14:15:22Z",    "next_cursor": "string"  },  "request_id": "string",  "usage": {    "credits_charged": 0,    "credits_remaining": 0,    "unit": "usd_micro",    "unlocked_until": "2019-08-24T14:15:22Z"  },  "action_receipt": {    "receipt_id": "64d0a161-468e-472a-b00e-a06ee9ab7de7",    "command_id": "7d510d78-7444-4252-aeac-9e473949661e",    "operation": "unlock_list_fields",    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"  },  "idempotent_replay": true}