Skip to main content
GET
Read a table of companies a people search can follow

Authorizations

X-API-Key
string
header
required

Query Parameters

table_id
string<uuid>
required

The table holding the companies.

column_id
string<uuid>
required

The column with each company's website, web address, LinkedIn company page or numeric LinkedIn id. A column of company names matches no one.

view_id
string<uuid> | null

A saved view of that table: only the rows its filter keeps are read. Omit it to read every row.

Response

Successful Response

What a table column holds right now, read the way a people search following it reads it.

column_name
string
required

The column's name.

companies
integer
required

How many distinct companies the column holds now: websites, web addresses, LinkedIn company pages and ids, each counted once.

examples
string[]
required

The first few of those companies, in row order.

names_skipped
integer
required

How many distinct values look like company names rather than websites or LinkedIn pages. A search cannot match a name, so it leaves them out.

table_name
string
required

The table's name.

too_many
boolean
required

Whether the column holds more companies than one search can follow (5,000). A search following it is refused until a view narrows it.

view_name
string | null
required

The saved view whose rows are read, or null when every row is.