find-leads

Read a table of companies a people search can follow

What a column of one of your tables holds right now, read the way a people search following it (company_table) reads it: the table's, column's and view's names, how many distinct companies it holds, the first few of them, how many values are company names a search cannot match, and whether it holds more companies than one search can follow. With check_role, it also counts the people at each company and lists the companies no one works at (current) or once worked at (past), each with a company of the same name that does have people, when the table names one. Free to call, and adds nothing; the check takes up to half a minute the first time.

get/find-leads/company-table/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/find-leads/company-table/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

table_idstring uuid required

The table holding the companies.

column_idstring 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_idstring uuid nullable

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

check_role'current' | 'past'

Which of a person's jobs places them at an employer: the one held now, or one that ended.

Also list the companies no one in the people search works at: current counts the job held now, past one that ended. Omit it to read the column alone.

Response

Successful Response

column_namestring required

The column's name.

companiesinteger required

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

examplesstring[] required

The first few of those companies, in row order.

names_skippedinteger required

How many distinct values are not a company's website or LinkedIn page, such as company names or people's LinkedIn profiles. A search cannot match them, so it leaves them out.

table_namestring required

The table's name.

too_manyboolean 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_namestring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.