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

curl --request GET \
  --url https://origami.chat/api/v2/tables/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "leadCount": 123,
  "columns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "slug": "<string>",
      "autoTrigger": true,
      "credits": {
        "lifetimeUsed": 123
      },
      "cells": {
        "running": 1,
        "errored": 1
      },
      "stats": {
        "avgCreditsPerRun": 123,
        "callRate": 0.5,
        "totalRuns": 123
      },
      "qualification": {
        "pass": 123,
        "fail": 123,
        "unsure": 123,
        "total": 123
      }
    }
  ],
  "credits": {
    "lifetimeUsed": 123
  },
  "cells": {
    "running": 1,
    "errored": 1
  },
  "url": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "stats": {
    "creditsPerLead": 123,
    "creditsPerQualifiedLead": 123,
    "findMoreEstimatedCredits": 123,
    "qualification": {
      "rate": 0.5,
      "fetchRate": 0.5,
      "qualifiedLeads": 123,
      "effectiveLeadsPerQualified": 123,
      "estimatedQualifiedLeads": 123
    },
    "funnel": {
      "totalSourcedLeads": 123,
      "postStaticLeads": 123,
      "dedupedLeads": 123,
      "dedupRate": 0.5,
      "excludedLeads": 123,
      "excludedRate": 0.5
    },
    "running": {
      "runningLeads": 123,
      "oldestActiveRunStartedAt": "2023-11-07T05:31:56Z"
    },
    "leadSources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "avgCreditsPerLead": 123,
        "totalCredits": 123,
        "totalLeads": 123
      }
    ],
    "hasUnknownTotalWithMore": true
  }
}

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/v1/tables/{id}/rows.

GET

tables

{id}

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

curl --request GET \
  --url https://origami.chat/api/v2/tables/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "leadCount": 123,
  "columns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "slug": "<string>",
      "autoTrigger": true,
      "credits": {
        "lifetimeUsed": 123
      },
      "cells": {
        "running": 1,
        "errored": 1
      },
      "stats": {
        "avgCreditsPerRun": 123,
        "callRate": 0.5,
        "totalRuns": 123
      },
      "qualification": {
        "pass": 123,
        "fail": 123,
        "unsure": 123,
        "total": 123
      }
    }
  ],
  "credits": {
    "lifetimeUsed": 123
  },
  "cells": {
    "running": 1,
    "errored": 1
  },
  "url": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "stats": {
    "creditsPerLead": 123,
    "creditsPerQualifiedLead": 123,
    "findMoreEstimatedCredits": 123,
    "qualification": {
      "rate": 0.5,
      "fetchRate": 0.5,
      "qualifiedLeads": 123,
      "effectiveLeadsPerQualified": 123,
      "estimatedQualifiedLeads": 123
    },
    "funnel": {
      "totalSourcedLeads": 123,
      "postStaticLeads": 123,
      "dedupedLeads": 123,
      "dedupRate": 0.5,
      "excludedLeads": 123,
      "excludedRate": 0.5
    },
    "running": {
      "runningLeads": 123,
      "oldestActiveRunStartedAt": "2023-11-07T05:31:56Z"
    },
    "leadSources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "avgCreditsPerLead": 123,
        "totalCredits": 123,
        "totalLeads": 123
      }
    ],
    "hasUnknownTotalWithMore": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

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

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

Show child attributes

credits

object

required

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

Show child attributes

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".

Show child attributes

url

string<uri>

required

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

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

stats

object

Present only when caller passes ?include=stats.

Show child attributes

List tables in the agent's workspace