Search

Search candidates in my Recruiter, every filter typed

Search candidates in Recruiter on your own seat, with each Recruiter filter as its own typed input.

At most 100 rows per call: LinkedIn's page size for this search.

LinkedIn returns at most 2,500 rows for one search; narrow the filters to reach the rest.

Needs a Recruiter seat on your own LinkedIn account.

Look filter ids up with lookup_search_ids service RECRUITER: that input selects which product's list is searched.

networkDistance in a row is defined as DISTANCE_1 / DISTANCE_2 / DISTANCE_3 (a published sample row also shows OUT_OF_NETWORK), while a profile reports FIRST_DEGREE / SECOND_DEGREE / THIRD_DEGREE for the same thing: do not compare the two as text.

A Recruiter row often has no publicIdentifier and no profile link: its id is the only handle, and only Recruiter actions take it.

Docs: https://heyreagent.com/docs/actions/search_linkedin_recruiter_people

post/v1/actions/search_linkedin_recruiter_people

Request

  • Base URL: https://api.heyreagent.com
  • URL: https://api.heyreagent.com/v1/actions/search_linkedin_recruiter_people
  • Auth: HTTP bearer

Request body

keywordsstring

Words to search for. AND, OR and NOT may be used, e.g. developers AND product owners NOT managers.

locale'arabic' | 'bangla' | 'czech' | 'danish' | 'german' | 'greek' | 'english' | 'spanish' | 'persian' | 'finnish' | 'french' | 'hindi' | 'hungarian' | 'indonesian' | 'italian' | 'hebrew' | 'japanese' | 'korean' | 'marathi' | 'malay' | 'dutch' | 'norwegian' | 'punjabi' | 'polish' | 'portuguese' | 'romanian' | 'russian' | 'swedish' | 'telugu' | 'thai' | 'tagalog' | 'turkish' | 'ukrainian' | 'vietnamese' | 'chinese_simplified' | 'chinese_traditional'

The language your Recruiter is set to, when results look inconsistent.

savedFilterstring

One of your saved filters: an id from lookup_search_ids type SAVED_FILTERS, service RECRUITER.

locationWithinAreanumber

Miles around the location.

employmentTypestring[]

Employment types. Recruiter PRO contracts only.

groupsstring[]

LinkedIn groups: ids from lookup_search_ids type GROUPS, service RECRUITER.

functionstring[]

Job functions: ids from lookup_search_ids type DEPARTMENT, service RECRUITER.

profileLanguagestring[]

Profile languages, as two-letter codes such as "en".

spotlightsstring[]

Spotlights. Advanced Recruiter subscriptions only.

firstNamestring[]

First names.

lastNamestring[]

Last names.

hasMilitaryBackgroundboolean

Only people with a US military background.

pastApplicantsboolean

Only past applicants.

notesstring[]

Words in your team's notes on the person.

limitnumber

How many to return (1–100, default 10).

cursorstring

nextCursor from the previous call, to get the next page. Keep the other arguments the same.

connectionIdstring

Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.

Response

It worked. Inside result: returned, nextCursor, results[].type, results[].id, results[].publicIdentifier, results[].publicProfileUrl, results[].profileUrl, results[].profilePictureUrl, results[].profilePictureUrlLarge, results[].memberUrn, results[].name, results[].firstName, results[].lastName, results[].networkDistance, results[].location, results[].industry, results[].keywordsMatch, results[].headline, results[].connectionsCount, results[].followersCount, results[].pendingInvitation, results[].canSendInmail, results[].hiddenCandidate, results[].interestLikelihood, results[].recruiterCandidateId, results[].recruiterPipelineCategory, results[].premium, results[].verified, results[].sharedConnectionsCount, results[].recentPostsCount, results[].recentlyHired, results[].mentionedInTheNews, results[].interests.

oktrue required
resultobject required

What was asked for. A field that does not apply is left out, or is null.

Changes

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