Skip to main content
POST
Check one or more LinkedIn company URLs before you register them. Nothing is created. For each URL Clustr says:
  • which company page it resolves to: name, logo, domain and headcount;
  • whether that company is already one of your competitors, with its id (existing_competitor_id);
  • how many Sales and CS people the team search finds there (people_found), read from the first page of the search, which reports the total;
  • the first page of those people (people: public_identifier, name, title, photo_url, function and group), to follow or skip when you register. group is the role group of the person’s title in your title list (sales, cs, exec, founder, customer_facing), the same groups title_groups takes; custom when no title in your list matches;
  • how many slots those people would take (slots_needed, at most 200 per competitor).
The totals add up the new companies and compare them with your free slots. Each monitored person takes one slot, whatever the competitor. When a batch needs more slots than are free, the people beyond the free slots are added Paused (no slot), and you choose later who to monitor. A URL that is a person’s profile (linkedin.com/in/...) answers status: "person_profile" with the message “That’s a person’s profile, not a company page”. The other URLs are checked anyway. Clustr keeps the people count for 24 hours, so registering right after the preview reuses the same search instead of paying for it twice.

​
Response

Each entry of companies has status: slots_needed is 0 for a company that is already registered (already_registered: true).

Authorizations

​
Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Body

application/json
​
urls
string[]
required

One to 20 LinkedIn company page URLs (https://www.linkedin.com/company/...).

Required array length: 1 - 20 elements
Example:
​
title_groups
enum<string>[]

The roles to search for: sales, cs, exec, founder, customer_facing and custom. Omit for your enabled job titles.

Available options:
sales,
cs,
exec,
founder,
customer_facing,
custom
Example:
​
max_people
integer

How many people to return per company. The search reads page after page until it has them; each page holds about 10. Omit for the first page.

Required range: 0 <= x <= 200
Example:

50

Response

One entry per URL, plus the slots they would take

​
success
boolean
required
Example:

true

​
data
object
required