Skip to main content
GET
Get table details

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required

Response

Successful Response

A table definition with its authoritative row counter.

auto_run
boolean
required

Whether data changes request recompute runs by themselves. Column-definition changes always recompute.

created_at
string<date-time>
required
description
string | null
required
has_import_source
boolean
required

Whether a connected tool's records are imported into this table: the tool and its refresh are the table's source (GET /tables/{table_id}/source/).

Whether a lead search fills this table: its criteria are the table's lead search (GET /tables/{table_id}/lead-search/). False for a table typed by hand, loaded from a file or fed by a connected tool, and for one whose search reads a dataset no longer offered.

has_subdomain_feed
boolean
required

Whether a subdomain search made this table, so it reads that domain again to add new subdomains, by hand or on the table's refresh schedule (GET /tables/{table_id}/subdomain-feed/).

id
string<uuid>
required
keep_existing_results
boolean
required

Whether a manual run-all only fills the errored, empty and stale cells rather than recomputing every cell in scope.

name
string
required
row_count
integer
required

Exact row count, maintained atomically by row mutations.

updated_at
string<date-time>
required
ai_made
boolean
default:false

Whether the AI Assistant created this table through a granted action. The owner is still the person who approved it.

archived_at
string<date-time> | null

When somebody archived it; null for a table on the list. An archived table is left out of All, its folder, Favorites and Recent, and still found by search and opened as before.

deleted_at
string<date-time> | null

When the table was moved to trash; null for a live table.

folder_id
string<uuid> | null

The folder it sits in; null for the top level.

folder_path
TableFolderCrumbSchema · object[]

The folders on the way to it, from the top level down; empty at the top level. What the list says under a search result and the table's own breadcrumb shows.

former_tags
string[]

The tags it carried when folders replaced tags, when it carried more than one and so waits for somebody to file it. Empty once it is filed.

has_webhook_endpoint
boolean
default:false

Whether an app sends records to this table through a webhook URL, live or revoked: its URL and what it received are the table's webhook (GET /tables/{table_id}/webhook-endpoints/).

is_favorite
boolean
default:false

Whether the CALLING USER starred this table. Per-user, so a teammate may see a different value. Always false for API-key callers, which have no user to have preferences.

last_viewed_at
string<date-time> | null

When the calling user last opened this table; null means never.

owner_display_name
string | null

The owner's name, resolved for display. Null when there is no owner or the account has no name to show.

owner_user_id
string | null

Who created the table. Null for tables older than this field and for anything a background job created. NOT an access control: every member of the organisation can open and edit every table.

shared_as_template
boolean
default:false

Whether this table's shape is readable by anyone with the link, with no sign-in. Never its rows.

table_type
enum<string>
default:other

What one row stands for: person, company or other. Other for a table made by hand, loaded from a file or fed by a connected tool, until somebody sets it; a lead search for people or companies sets it when it fills the table. A company table offers Find people at its companies.

Available options:
person,
company,
other

Whether a lead search for people or companies fills this table, so table_type is the search's to say and an update that changes it is refused.