Skip to main content
POST
Add a lookup column to a list.

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

Body

application/json

Lookup column to add

Request body for adding a lookup column — a computed, read-only column whose values are derived live (no writes). Discover available lookup types via GET /lists/actions (entries that carry a lookupType).

lookupType
string
required

The lookup type to add, e.g. "sequence_status" or "agent_conversations". See LOOKUP_TYPE_* constants / GET /lists/actions.

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

The created (or existing) lookup column

Response returned after creating a column

header
object

The newly-created column