---
title: "Read a table of companies a people search can follow"
method: GET
path: "/find-leads/company-table/"
tags: ["find-leads"]
---

# Read a table of companies a people search can follow

`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

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.

## 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, 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.

## Response `200`

Successful Response

- CompanyTableResponseSchema: 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.
  - `matches` CompanyMatchCheckSchema: How many of the column's companies the people search has people at.
    - `checked` integer, required: How many of the column's companies were counted. Fewer than `companies` when the check ran out of time; asking again carries on.
    - `role` 'current' | 'past', required: Which of a person's jobs places them at an employer: the one held now, or one that ended.
    - `unmatched` UnmatchedCompanySchema[], required: The first 100 of those companies, in row order.
      - `company` string, required: The company as the column holds it: its website or page.
      - `name` string, nullable, required: The company's name from the same row, read from the table's column of company names when it has one; null otherwise.
      - `suggestion` CompanyNameSuggestionSchema, required: A company of the same name that the people search does have people at.
        - `name` string, required: The company's name, as the table spells it.
        - `people` integer, required: How many people the people search holds at the company of that exact name, in the job the check counted (held now, or one that ended).
    - `unmatched_count` integer, required: How many counted companies no one in the people search works at, even matched by the domain the search files them under. A search following the column finds nobody there.
  - `names_skipped` integer, 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_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, nullable, required: The saved view whose rows are read, or null when every row is.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: The table, the column or the view was deleted.
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)