OpenAPI 3.0.3AGPL-3.0 license2026-08-2011401.7 MB

9217eedacbb8

contacts

Search and filter contacts

Search saved people: name, profile URL, optional Fit / not-a-fit, outreach status, tags, score, and list membership. Supports pagination and sorting.

get/contacts/search

Query parameters

linkedinUrlstring

Filter by LinkedIn URL (exact match)

Filter by LinkedIn URL (exact match)

namestring

Filter by name (partial match)

Filter by name (partial match)

lifecycleStage'contact' | 'lead' | 'qualified' | 'rejected'
sortBystring

Sort order. One of: updatedAt_desc / updatedAt_asc (most recent activity — default), hotScore_desc / hotScore_asc, lastRepliedAt_desc / lastRepliedAt_asc, lastContactedAt_desc / lastContactedAt_asc, createdAt_desc / createdAt_asc, name_asc / name_desc, profileUpdatedAt_desc / profileUpdatedAt_asc.

Sort order. One of: updatedAt_desc / updatedAt_asc (most recent activity — default), hotScore_desc / hotScore_asc, lastRepliedAt_desc / lastRepliedAt_asc, lastContactedAt_desc / lastContactedAt_asc, createdAt_desc / createdAt_asc, name_asc / name_desc, profileUpdatedAt_desc / profileUpdatedAt_asc.

minHotScoreinteger
outreachStatus'none' | 'connection_sent' | 'connected' | 'dm_sent' | 'followed_up' | 'replied' | 'in_conversation' | 'meeting_booked' | 'not_interested'
tagstring

Filter by tag

Filter by tag

doNotContact'true' | 'false'
hasProfileData'true' | 'false'
campaignIdstring
engaged'true' | 'false'

Default true: return only people with outreach started, a reply, or membership in a real (non chat-draft) list. Pass false for every saved row including collected residue. Ignored when campaignId is set, since that is already an explicit list.

Default true: return only people with outreach started, a reply, or membership in a real (non chat-draft) list. Pass false for every saved row including collected residue. Ignored when campaignId is set, since that is already an explicit list.

omitData'true' | 'false'

Return identity and verdict only: no profile blob, no campaign membership, no timestamps. Much smaller, and a different row shape rather than the same one with holes.

Return identity and verdict only: no profile blob, no campaign membership, no timestamps. Much smaller, and a different row shape rather than the same one with holes.

limitinteger
offsetinteger

Response

Matching contacts. The row shape depends on omitData.

successtrue required
creditsUsedinteger required

Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.