Skip to main content
POST
Start a LinkedIn watch on a new table

Authorizations

X-API-Key
string
header
required

Body

application/json

A LinkedIn watch to start on a new table, with what a person approves for it.

A watch keeps adding the people it finds, every day, up to people_per_day, and pauses itself when its total limit is spent, its table is full or the workspace runs out of credits.

client_request_id
string
required

A key unique to this start. Sending the same start again with the same key answers with the watch the first one made, never a second watch.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9._:-]+$
record_type
enum<string>
required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
hiring_companies,
backlinks,
post_engagers,
profile_engagers,
page_engagers,
topic_mentions,
event_attendees,
search_results

The sites linking to a domain or a page.

Name the target and get one row per referring site by default, sorted by the rank the link passes. Every attribute of a backlink the index can filter on is here, in four groups: the referring site, the referring page, the link itself, and the page it points at. The index takes at most eight filter conditions in one search, counting every value of every list as one; a ninth is refused rather than dropped.

companies
CompanyQuerySchema · object | null

Filters for a company search.

enrich_new_rows
boolean
default:true

Whether the enrichment columns run on each person as they arrive. False leaves their cells waiting for a person to run them.

enrichments
enum<string>[]

Columns to add that find more about each person, for example find_email. Each is billed per person that comes back with an answer.

Maximum array length: 4

An enrichment offered at import, in the user's vocabulary not the catalog's.

Each option names an outcome and resolves to the curated enrichment that delivers it, so importing leads stays a question about what you want rather than about who supplies it.

Kept as its own enum rather than reusing the capability keys directly: the import page offers a deliberately short list, and which enrichments belong on it is a product decision that should not change every time the catalog gains a capability.

Available options:
find_email,
find_phone,
enrich_contact,
enrich_company
event_attendees
EventAttendeesQuerySchema · object | null

A LinkedIn watch on events: who says they are attending.

hiring_companies
HiringCompaniesQuerySchema · object | null

Filters for a search for companies with open roles matching a job title.

The rows are companies, one per employer, each carrying every open posting the search read for it. The count is of open postings, since the companies are folded from them once they are read.

local_businesses
LocalBusinessQuerySchema · object | null

Filters for a map search over business listings.

The one search here that asks "who is within this radius". Name a category, a business name or a website to look for, plus an area to look in for the radius part.

lookalikes
LookalikeQuerySchema · object | null

Filters for a search for companies resembling a set of seed companies.

page_engagers
PageEngagersQuerySchema · object | null

A LinkedIn watch on company pages: who engages with the posts they publish.

people
PeopleQuerySchema · object | null

Filters for a people search.

people_per_day
integer
default:25

The most people the watch adds in one day. The daily ceiling a person approves: people found past it wait for the next day.

Required range: 1 <= x <= 1000
post_engagers
PostEngagersQuerySchema · object | null

A LinkedIn watch on posts somebody names: who reacts to or comments on them.

The posts are the watch: at least one is required.

profile_engagers
ProfileEngagersQuerySchema · object | null

A LinkedIn watch on people somebody names: who engages with the posts they publish.

search_results
SearchResultsQuerySchema · object | null

Google searches to run, each landing the results Google shows for it.

Write each search the way you would type it into Google: operators (site:, intitle:, quoted phrases) work and cost nothing extra. One row is one result of one search, with the search that found it and its rank.

signal_companies
SignalCompaniesQuerySchema · object | null

Filters for a company buying-signal search.

signal_people
SignalPeopleQuerySchema · object | null

Filters for a person activity-signal search.

spend_limit
number | null

The most the watch may spend on the people it adds, in credits, before it pauses itself. Omit for 30 days of its daily ceiling.

Required range: 1 <= x <= 10000000
table_name
string | null

The new table's name; omit it and the table is named after the watch.

Required string length: 1 - 255
topic_mentions
TopicMentionsQuerySchema · object | null

A LinkedIn watch on keywords: who posts about them, or engages with posts that do.

Response

Successful Response

The table a watch was started on, and the watch.

created
boolean
required

False when this start repeated one already made with the same key.

table_id
string<uuid>
required
table_name
string
required
watch
LeadWatchSchema · object
required

A table's LinkedIn watch: where it stands and what it may spend.