> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supersonic.cv/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists & Pipelines

> Create pipelines, kanban boards, and segmented lists with custom fields and entries.

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

| 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`                      |

<Tip>
  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.
</Tip>

## Examples

### Create a sales pipeline with stages

<CodeGroup>
  ```json Create the Pipeline theme={null}
  {
    "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"
        }
      ]
    }
  }
  ```

  ```json Add a Deal to the Pipeline theme={null}
  {
    "tool": "lists.add_entry",
    "params": {
      "list_id": "lst_abc123",
      "record_id": "rec_deal_01",
      "data": {
        "Stage": "Qualified",
        "Expected Close": "2026-04-15"
      }
    }
  }
  ```

  ```json Move Deal to Next Stage theme={null}
  {
    "tool": "lists.update_entry",
    "params": {
      "list_id": "lst_abc123",
      "record_id": "rec_deal_01",
      "data": {
        "Stage": "Proposal Sent"
      }
    }
  }
  ```
</CodeGroup>

### Bulk add records to a list

```json theme={null}
{
  "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" } }
    ]
  }
}
```