Lists CLI | Bigmind

Lists CLI commands work with Bigmind Lists using the signed-in Desktop user's permissions. Use them to inspect list metadata, manage columns, read and write rows, and manage targetable people on account-based lists.

#List commands

Command	Description
`bigmind api lists list`	List accessible lists.
`bigmind api lists create --json ...`	Create a list. If `source` is omitted, a free-form list is created.
`bigmind api lists get <tableId>`	Get list metadata and schema.
`bigmind api lists summary <tableId>`	Get row and column counts.
`bigmind api lists delete <tableId>`	Delete a list.

bigmind api lists create --json '{"name":"Account review queue"}'
bigmind api lists get tbl_123
bigmind api lists summary tbl_123

bigmind api lists create --json '{"name":"Account review queue"}'
bigmind api lists get tbl_123
bigmind api lists summary tbl_123

#Columns

Command	Description
`columns <tableId> list`	List columns and column order.
`columns <tableId> get <columnId>`	Get one column.
`columns <tableId> values <columnId>`	Get a value distribution for a column.
`columns <tableId> add --json ...`	Add one or more columns.
`columns <tableId> update <columnId> --json ...`	Update a column.
`columns <tableId> delete <columnId>`	Delete a column.
`columns <tableId> reorder --json ...`	Set column order.

bigmind api lists columns tbl_123 list
bigmind api lists columns tbl_123 values col_status --query limit=10 --query offset=0
bigmind api lists columns tbl_123 add --json '{"columns":[{"name":"Status","type":{"type":"text"},"view_scope":null}]}'
bigmind api lists columns tbl_123 update col_status --json '{"name":"Review status","view_scope":null}'
bigmind api lists columns tbl_123 reorder --json '{"columnIds":["col_name","col_status"]}'

bigmind api lists columns tbl_123 list
bigmind api lists columns tbl_123 values col_status --query limit=10 --query offset=0
bigmind api lists columns tbl_123 add --json '{"columns":[{"name":"Status","type":{"type":"text"},"view_scope":null}]}'
bigmind api lists columns tbl_123 update col_status --json '{"name":"Review status","view_scope":null}'
bigmind api lists columns tbl_123 reorder --json '{"columnIds":["col_name","col_status"]}'

#Rows

Command	Description
`rows <tableId> get`	Get a row summary, rows by ID, a row by index, or filtered rows.
`rows <tableId> add --json ...`	Add rows.
`rows <tableId> update-cells --json ...`	Update cells in existing rows.
`rows <tableId> delete --json ...`	Delete rows by ID.

bigmind api lists rows tbl_123 get --query rowIds=row_1,row_2
bigmind api lists rows tbl_123 get --query index=0
bigmind api lists rows tbl_123 get --query columnId=col_status --query operator=eq --query query=ready --query limit=25
bigmind api lists rows tbl_123 add --json '{"rows":[{"cells":{"col_status":"todo"}}]}'
bigmind api lists rows tbl_123 update-cells --json '{"updates":[{"rowId":"row_123","columnId":"col_status","value":"ready"}]}'
bigmind api lists rows tbl_123 delete --json '{"rowIds":["row_123"]}'

bigmind api lists rows tbl_123 get --query rowIds=row_1,row_2
bigmind api lists rows tbl_123 get --query index=0
bigmind api lists rows tbl_123 get --query columnId=col_status --query operator=eq --query query=ready --query limit=25
bigmind api lists rows tbl_123 add --json '{"rows":[{"cells":{"col_status":"todo"}}]}'
bigmind api lists rows tbl_123 update-cells --json '{"updates":[{"rowId":"row_123","columnId":"col_status","value":"ready"}]}'
bigmind api lists rows tbl_123 delete --json '{"rowIds":["row_123"]}'

#Targetable people

Targetable people commands work on lists that have a Targetable Account column and a Targetable People column.

Command	Description
`targetable-people <tableId> get`	Query people across account rows.
`targetable-people <tableId> add --json ...`	Add people to account rows matched by domain.
`targetable-people <tableId> update --json ...`	Patch matching people.
`targetable-people <tableId> delete --json ...`	Remove matching people.

bigmind api lists targetable-people tbl_123 get --query target=true --query personas=champion,decision_maker --query limit=25
bigmind api lists targetable-people tbl_123 add --json '{"accounts":[{"accountDomain":"example.com","people":[{"first_name":"Ada","last_name":"Lovelace","title":"VP Sales","email":"ada@example.com","personas":["decision_maker"]}]}]}'
bigmind api lists targetable-people tbl_123 update --json '{"accounts":[{"accountDomain":"example.com","people":[{"match":{"email":"ada@example.com"},"patch":{"target":true,"persona_rationale":"Owns the evaluation."}}]}]}'
bigmind api lists targetable-people tbl_123 delete --json '{"accounts":[{"accountDomain":"example.com","people":[{"email":"ada@example.com"}]}]}'

bigmind api lists targetable-people tbl_123 get --query target=true --query personas=champion,decision_maker --query limit=25
bigmind api lists targetable-people tbl_123 add --json '{"accounts":[{"accountDomain":"example.com","people":[{"first_name":"Ada","last_name":"Lovelace","title":"VP Sales","email":"ada@example.com","personas":["decision_maker"]}]}]}'
bigmind api lists targetable-people tbl_123 update --json '{"accounts":[{"accountDomain":"example.com","people":[{"match":{"email":"ada@example.com"},"patch":{"target":true,"persona_rationale":"Owns the evaluation."}}]}]}'
bigmind api lists targetable-people tbl_123 delete --json '{"accounts":[{"accountDomain":"example.com","people":[{"email":"ada@example.com"}]}]}'