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

# Create Empty List

`POST /lists/create-empty`

## Request

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

Create a list with nothing in it, to fill later.

SEND AN `idempotency_key`. Without one a retried request makes a second
empty list, and a duplicate list is harder to notice than a failed call.

## Headers

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

## Request body

- CreateEmptyListRequest: Create a list with nothing in it, to fill later. `idempotency_key` is worth using: without one, a retried create makes a SECOND empty list, and a duplicate list is harder to notice than a failed request.
  - `title` string, required
  - `source` 'csv' | 'graph8' | 'FormSubmission' | 'visitor' | 'salesforce' | 'hubspot' | 'keyword' | 'intent' | 'workbench', required: Where the list comes from, e.g. `csv`.
  - `type` 'contacts' | 'companies' | 'suppressions' | 'deals' | 'leads': What the list holds. The wire name is `type`; the app's field is `type_` because `type` is a Python builtin, and the alias keeps the wire name identical to the app's.
  - `status` 'completed' | 'processing' | 'failed'
  - `is_dynamic` boolean: A dynamic list re-runs its query; a static one keeps what it is given.
  - `description` string, nullable
  - `idempotency_key` string, nullable: Retry-safe: the same key returns the same list.
  - `request_fingerprint` string, nullable

## Response `201`

Successful Response

- ApiResponseListPayload
  - `data` ListPayload, required: An open envelope for a list, a capability map or a job result. Open because several of these return the whole `Audience`, whose shape carries per-source metadata that differs between an uploaded file, a dynamic query and a master list - and grows with them.
  - `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/89fc11143b70?raw)