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

> ## Agent Instructions
> Collabase documentation. Interface labels are quoted in English, as they appear in the product.
> Features marked Enterprise need the Collabase Enterprise Edition licence.

# Create CRM list

> Create a static list of chosen records or a dynamic list that follows a query, owned by the token owner.

Creates a list on one type of record. A **static** list holds the records someone adds. A **dynamic**
list shows the records a query matches and needs `cql`. Adding entries, columns and shares is done in
the app.

> [!NOTE]
>
> Scope `crm:write`. The token owner needs the right to create lists and to read the type.

## Request body

**name** `string` *required*

Up to 120 characters.

**typeKey** `string` *required*

The type of the records, such as `company`.

**kind** `string` *required*

`STATIC` or `DYNAMIC`.

**cql** `string`

The query of a dynamic list; not allowed for a static one.

**visibility** `string` (default: PRIVATE)

`PRIVATE` or `SHARED`.

**groupId** `string | null`

The group of lists it sits in.

## Response

The created list, with status `201`.

```bash cURL theme={"dark"}
curl -X POST "https://your-collabase.ch/api/v1/crm/lists" \
  -H "Authorization: Bearer cb_xYz123ABCD..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customers with AG",
    "typeKey": "company",
    "kind": "DYNAMIC",
    "cql": "title ~ \"AG\""
  }'
```

```json 201 theme={"dark"}
{ "data": { "id": "cm3list001", "name": "Customers with AG", "kind": "DYNAMIC" } }
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.