Skip to main content
GET
Get a list's metadata and column headers without any 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.

Response

List metadata and column headers (no rows)

Response envelope for GET /lists//schema. Returns the list's metadata and column headers only — no rows. Use this to discover column names/types before reading or writing rows.

list
object

List metadata and column headers (no rows)