Skip to main content
POST
Duplicate a smart list and all its active row data.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

listId
string
required

Query Parameters

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

Body

application/json

Optional copy name; send {} to use the default

name
string

Name of the copy (1–100 characters). Defaults to the source name followed by " (copy)".

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

Response

Independent list copy with headers and copied row count

Response returned after creating a list. Includes the list's column headers so callers know the exact column names/types to read or write rows against — no follow-up request is needed.

id
string

ID (UUID) of the newly created list

name
string

Name of the newly created list

type
string

List type: "leads", "companies", or "custom"

headers
object[]

Ordered column definitions created for the list. Use these column names when adding or updating rows.

count
integer

Number of active rows copied, including rows with empty cells.

sharing
string

Sharing visibility retained from the source list.

departmentIds
string[]

Department restrictions retained from the source list.