Skip to main content
GET
Get a table — name, leadCount, columns, credits, optional economics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tableId
string<uuid>
required

Query Parameters

include
string

Pass stats to attach the economics block (creditsPerLead, qualification, funnel, lead sources) plus per-column stats and qualification.

Example:

"stats"

Response

The table object

object
string
required
Allowed value: "table"
id
string<uuid>
required
workspaceId
string<uuid>
required
name
string
required
leadCount
integer
required

Non-deleted row count. v2 wire vocabulary speaks "leads" instead of "rows"; the underlying DB column is still rows.

columns
object[]
required
credits
object
required

Lifetime credit cost across every cell. Equals the sum of every columns[].credits.lifetimeUsed.

cells
object
required

Table-level liveness rollup — sums every columns[].cells. running > 0 means at least one cell on the table is still being processed (e.g., enrichment kicked off by a recent run hasn't fully settled). The calling agent should treat this as "still working", not "no data found".

url
string<uri>
required

Deep link a human can open. For programmatic row reads, use GET /api/v2/tables/{tableId}/rows.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
stats
object

Present only when caller passes ?include=stats.