Skip to main content
GET
List Prospects

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

listId
string<uuid>

Optional single-list shortcut. When present, it replaces listsIds with [listId]; it does not override campaignsIds, search, importance, frequency, or touch-point filters.

campaignsIds
string<uuid>[]

Campaign IDs to filter within the accessible Prospects scope. Omit or pass [] for no campaign restriction; non-empty campaign and list filters intersect with the other active filters.

Maximum array length: 1000
isImportant
boolean

Optional filter to only show important or non-important prospects.

postFrequency
enum<string>

Filter the stored direct-post weekly frequency estimate: MORE_THAN_TWICE_PER_WEEK >2; ONE_TO_TWO_TIMES_PER_WEEK 1–2 inclusive; ONE_TO_THREE_TIMES_PER_MONTH 0.25–0.99 inclusive; LESS_THAN_ONCE_PER_MONTH <0.25. This is based on fetched activity, not a live or calendar-month LinkedIn count.

Available options:
MORE_THAN_TWICE_PER_WEEK,
ONE_TO_TWO_TIMES_PER_WEEK,
ONE_TO_THREE_TIMES_PER_MONTH,
LESS_THAN_ONCE_PER_MONTH
listsIds
string<uuid>[]

List IDs to filter by; omit or pass [] for no list restriction. If listId is supplied, it replaces this array with [listId], rather than intersecting with it. Other active filters still apply.

Maximum array length: 1000
sortBy
enum<string>

Sort field: prospectName = stored LinkedIn full name; campaignName = campaign name; postFrequency = direct weekly post frequency; totalComments = published direct comments only; lastComment = stored direct comment timestamp (may include POSTING); lastPostCheck = last successful post-fetch finish. Omit for name ascending.

Available options:
prospectName,
campaignName,
postFrequency,
totalComments,
lastComment,
lastPostCheck
sortOrder
enum<string>

ASC sorts the chosen field ascending; DESC sorts it descending. If omitted, lastComment and lastPostCheck default to DESC and other explicit fields to ASC. If sortBy is omitted, the backend uses name ASC even if sortOrder is supplied.

Available options:
ASC,
DESC

Case-insensitive stored LinkedIn full-name search after whitespace normalization; % and _ remain SQL LIKE wildcards. Does not search headline, company or profile URL. An empty normalized term adds no search restriction. A non-empty term currently replaces the default successful-enrichment predicate.

numberOfTouchPoints
enum<string>[]

OR-filter on published or already POSTING direct-plus-indirect comments, not likes, DMs or connection requests. Omitting it or passing [] disables this filter. COMMENTED_1_TIME through COMMENTED_5_TIMES mean exactly 1 through 5; COMMENTED_6_AND_MORE_TIMES means 6 or more.

Comment touch-point bucket: COMMENTED_1_TIME through COMMENTED_5_TIMES = exactly 1 through 5 published or POSTING direct-plus-indirect comments; COMMENTED_6_AND_MORE_TIMES = at least 6.

Available options:
NOT_COMMENTED,
COMMENTED_1_TIME,
COMMENTED_2_TIMES,
COMMENTED_3_TIMES,
COMMENTED_4_TIMES,
COMMENTED_5_TIMES,
COMMENTED_6_AND_MORE_TIMES
limit
integer

Optional positive integer page size, at most 1000; omitted uses the backend default of 5. This is pagination, not a total-results cap. Pass it explicitly and use the returned pagination to read further pages.

Required range: x <= 1000
offset
integer

Optional zero-based offset in the same filtered result; omitted starts at 0. Keep the same filters and ordering when advancing pages. The public maximum is 2147483647.

Required range: 0 <= x <= 2147483647

Response

status
string
required

Response status

Allowed value: "success"
data
object
required

Prospects response with optional pagination

message
string
required

Success message

Example:

"Operation completed successfully"