Get a List
GET
Read one saved List. A restricted definition returns only ID, version, lifecycle and subject type for recovery; no rule, columns or members. Use update_list with an authorized replacement definition, including while archived.
header
AuthorizationBearer <token>A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.
list_id*stringMatch
^list_[0-7][0-9A-HJKMNP-TV-Z]{25}$SMB-Workspace-Id*stringFormat
uuidSuccessful authorized response.
application/json- response
data*|request_id*stringcurl -X GET 'https://example.com/v1/lists/string' \ -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "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"}