Sign in

v1

latestOpenAPI 3.1.02026-07-267154122.0 KB
Tables

Get a table — name, leadCount, columns, credits, optional economics

The canonical "what's in this table and what did it cost?" surface in v2. Same shape as the entries in Run.response.tables[] and GET /agents/{id}/tables.

Default shape is lite — leadCount, columns[] with per-column credits.lifetimeUsed, table-level credits.lifetimeUsed (sum of the column breakdown). Pass ?include=stats to attach the economics block — the same numbers the UI shows at the top of the table (creditsPerLead, qualification breakdown, funnel, lead sources, ...).

credits.lifetimeUsed accumulates across every agent run that ever populated cells on this table — it is the unit a human thinks in when they ask how much a list cost. It does NOT include still-active cell-run reservations; wait for the relevant run to terminate before reading the final number.

Scoped to the API key's org. There is no API-owned filter on tables, so any non-deleted table in your org is fetchable. For programmatic row reads, use GET /api/v2/tables/{tableId}/rows.

get/tables/{tableId}

Query parameters

includestring
Example:stats

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

Response

The table object

object'table' required
idstring uuid required
workspaceIdstring uuid required
namestring required
leadCountinteger required

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

urlstring uri required

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

createdAtstring date-time required
updatedAtstring date-time required