contacts

Search and filter contacts

Changed on

Search saved people: name, profile URL, removed or still in the list, outreach status, tags, and list membership. Supports pagination and sorting.

get/contacts/search

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/contacts/search
  • Auth: HTTP bearer

Query parameters

linkedinUrlstring

Filter by LinkedIn URL (exact match)

namestring

Filter by name (partial match)

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

Sort key as field_asc or field_desc. Fields: updatedAt (most recently active), lastRepliedAt, lastContactedAt, createdAt, name, profileUpdatedAt. Default: createdAt_desc, newest first. With campaignId also whyNowAt_desc, the most recent reason to write first, and fitScore_desc, best fit first; people without one follow.

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

Filter by tag

'true' | 'false'
OR
boolean
'true' | 'false'
OR
boolean
campaignIdstring
fitAtLeastinteger

With campaignId: only the people the fit check scored at least this.

'true' | 'false'
OR
boolean
'true' | 'false'
OR
boolean
limitinteger
offsetinteger

Response

Matching contacts. The row shape depends on omitData.

successtrue required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

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

Changes

  • 549f4adbbfcfRevision changes
    • info

      added the new optional query request parameter fitAtLeast

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • bdaed6984b20Revision changes
    • warning

      removed the optional property from the response with the status