Tools
| Tool | Description | Key Params |
|---|---|---|
lists.list | List all lists in the workspace | object_type_slug (optional) |
lists.get | Get a single list with its fields and stages | list_id |
lists.create | Create a new list or pipeline | name, object_type_slug, fields |
lists.update | Update list name or settings | list_id, name |
lists.delete | Delete a list | list_id |
lists.add_field | Add a field to the list (e.g., a stage column) | list_id, name, field_type, config |
lists.remove_field | Remove a list field | list_id, field_id |
lists.entries | Get all entries in a list | list_id, filters, sort |
lists.add_entry | Add a record to the list | list_id, record_id, data |
lists.remove_entry | Remove a record from the list | list_id, record_id |
lists.update_entry | Update list-specific fields on an entry | list_id, record_id, data |
lists.bulk_add_entry | Add multiple records to a list at once | list_id, entries |
A pipeline is just a list with a
select field used as the stage. Create the list, add a “Stage” select field, then use board views to visualize it.Examples
Create a sales pipeline with stages
{
"tool": "lists.create",
"params": {
"name": "Sales Pipeline",
"object_type_slug": "deals",
"fields": [
{
"name": "Stage",
"field_type": "select",
"config": {
"options": [
"Qualified",
"Proposal Sent",
"Negotiation",
"Closed Won",
"Closed Lost"
]
}
},
{
"name": "Expected Close",
"field_type": "date"
}
]
}
}
{
"tool": "lists.add_entry",
"params": {
"list_id": "lst_abc123",
"record_id": "rec_deal_01",
"data": {
"Stage": "Qualified",
"Expected Close": "2026-04-15"
}
}
}
{
"tool": "lists.update_entry",
"params": {
"list_id": "lst_abc123",
"record_id": "rec_deal_01",
"data": {
"Stage": "Proposal Sent"
}
}
}
Bulk add records to a list
{
"tool": "lists.bulk_add_entry",
"params": {
"list_id": "lst_abc123",
"entries": [
{ "record_id": "rec_deal_02", "data": { "Stage": "Qualified" } },
{ "record_id": "rec_deal_03", "data": { "Stage": "Negotiation" } },
{ "record_id": "rec_deal_04", "data": { "Stage": "Qualified" } }
]
}
}