outreach
outreach

Get Outreach Candidates

Unified outreach candidates endpoint. Use type=dm for DM contacts, type=group for groups. Default type=dm for backward compatibility.

get/api/outreach/candidates

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/outreach/candidates
  • Auth: none declared

Query parameters

type'dm' | 'group'
segmentsstring nullable

Comma-separated: strong,medium,low,noise

channelsstring nullable

Comma-separated: telegram,whatsapp,email

limitinteger
offsetinteger
include_excludedboolean
statesstring nullable

Comma-separated: new,follow_up,active,warm,cooling,dormant,low

min_signal_scorenumber
max_days_since_contactinteger nullable
exclude_recent_daysinteger nullable
engagement_statesstring nullable
member_count_mininteger nullable
member_count_maxinteger nullable
min_overall_scoreinteger nullable
has_recent_activityboolean nullable
hide_contactedboolean nullable
show_ignoredboolean nullable
folder_idsstring nullable

Comma-separated inbox folder IDs

tag_idsstring nullable

Comma-separated AI tag IDs

searchstring nullable

Search by contact name or phone number

Response

Successful Response

totalinteger required
type'dm' | 'group' required
filtersobject required

Changes

No recorded changes to this operation across all 5 revisions of this API.