public

Enrich a list of contacts

Changed on

Enrich many of your own saved contacts in one call, by contact id from a list already shown, never a raw profile URL and never one public_profile per person: On full (the default) each person gets the fullest record we can read: the real headline, the current title with its start date, the dated career, schools, place and country, the About and languages, usually live, in about 2 seconds a person, in the background; preview gives only the basics: name, employer, place and photo. Not for email or phone; ask which people when the target is ambiguous rather than defaulting to everyone. Cost: at most 1 credit a person, nothing for a person a search already returned or one not read; degree details add nothing. creditsUsed says what the call spent.

post/public/enrich

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/public/enrich
  • Auth: HTTP bearer

Request body

contactIdsstring[] required

Which of your own contacts to (re)fetch. An explicit list: not a filter, so nothing is enriched by accident.

campaignIdstring

Link newly-touched contacts to this list (slug or id). In chat, omit it: the conversation's own list is used.

detail'preview' | 'full'

How much of each person to read. "preview": a quick look; it can miss the current title and older posts. "full" (default): every detail we have. Keep full unless a quick look at each person is enough. A person a search already returned is not read again.

withDegreeboolean

Degree details: also show how far each person is from you (1st, 2nd or 3rd). Off unless asked.

Response

Batch result (or a stillRunning partial for a batch that outlived this call's wait)

source'public' required
batchIdstring required

Pass this to GET the same endpoint if stillRunning is set, to check on it later.

totalinteger required

How many contacts were actually queued (already-fresh and unreachable ones are skipped up front).

visitedinteger required

Successfully re-fetched.

failedinteger required

Could not be reached (deleted, restricted, or no public page).

skippedinteger required

Deferred, not attempted this call.

creditsUsedinteger required

What the batch has spent so far, in credits: all of it once the batch is done.

notFoundstring[]

Contact ids in the request that are not yours, left out of the batch. When none of the ids is yours, the call answers 404 with this list and queues nothing.

status'processing' | 'completed' | 'partial' | 'failed' required
failureReasonstring
degreeReadinteger

With withDegree: how many people's connection degree was read.

degreeMissedinteger

With withDegree: how many people's connection degree could not be read.

degreeUnavailableboolean

With withDegree: no connection degree could be read for this batch.

degreeUnavailableReason'unavailable'

With degreeUnavailable, the degree details could not be added this time; the rest of each profile is complete.

stillRunningboolean

The batch outlived this call's wait and is still working: everything above is real and already landed, not a failure. Check back with GET ?batchId=.

Changes

  • b657f915ce03Revision changes
    • warning

      added the new unavailable enum value to the response property for the response status

    • info

      removed the account_limit enum value from the response property for the response status

    • info

      removed the account_signed_out enum value from the response property for the response status

    • info

      removed the no_account enum value from the response property for the response status

    • info

      removed the no_degree_in_answer enum value from the response property for the response status

    • info

      removed the not_saved enum value from the response property for the response status

    • info

      removed the read_failed enum value from the response property for the response status

  • d803625ea497Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status