Skip to main content
GET
/
agents
/
{id}
/
tables
List tables in the agent's workspace
curl --request GET \
  --url https://origami.chat/api/v2/agents/{id}/tables \
  --header 'Authorization: Bearer <token>'
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tables": [
    {
      "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

id
string<uuid>
required

Query Parameters

include
string

Pass stats to attach per-table economics on every entry (creditsPerLead, qualification, funnel, lead sources).

Example:

"stats"

Response

Tables in the agent's workspace

workspaceId
string<uuid>
required
tables
object[]
required