Skip to main content
Lists power pipelines, boards, and any grouped collection of records. A sales pipeline is a list. A project board is a list. Each has its own fields (like “Stage” or “Priority”) on top of the record’s base fields.

​
Tools

ToolDescriptionKey Params
lists.listList all lists in the workspaceobject_type_slug (optional)
lists.getGet a single list with its fields and stageslist_id
lists.createCreate a new list or pipelinename, object_type_slug, fields
lists.updateUpdate list name or settingslist_id, name
lists.deleteDelete a listlist_id
lists.add_fieldAdd a field to the list (e.g., a stage column)list_id, name, field_type, config
lists.remove_fieldRemove a list fieldlist_id, field_id
lists.entriesGet all entries in a listlist_id, filters, sort
lists.add_entryAdd a record to the listlist_id, record_id, data
lists.remove_entryRemove a record from the listlist_id, record_id
lists.update_entryUpdate list-specific fields on an entrylist_id, record_id, data
lists.bulk_add_entryAdd multiple records to a list at oncelist_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"
      }
    ]
  }
}

​
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" } }
    ]
  }
}