---
title: "Create List"
method: POST
path: "/lists"
tags: ["Lists"]
---

# Create List

`POST /lists`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/lists`
- Auth: HTTP bearer

Create a new empty list.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ListCreateRequest: Request body for creating a new list.
  - `title` string, required: Name of the list
  - `type` string: List type: contacts, companies, suppressions, deals, leads
  - `description` string, nullable: Optional note describing the list's purpose, readable by agents (#16641)

## Response `201`

Successful Response

- ApiResponseListCreateResponse
  - `data` ListCreateResponse, required
    - `id` integer, required
    - `title` string, required
    - `description` string, nullable
    - `type` string, nullable
    - `status` string, nullable
    - `total` integer
    - `warning` string, nullable: Set when another list already has this name. The list was still created.
    - `duplicate_list_ids` integer[], nullable: Ids of existing lists with the same name (case-insensitive), when any.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)
