public

Run a plan of searches

Changed on Oct 22, 2026

Run a ready plan returned by plan-searches, in the background, and save the people it finds into the conversation's list, or your contacts outside one. Answers within about 25 seconds with a receipt: people added so far, credits used, and each search's state. A run answers in about 6 seconds, and one in ten takes about 10 or more; the people come from our index, about 3 weeks old at the median, so a recent job move can be missing. A plan runs once: calling again with the same plan_id answers where its run stands and spends nothing more. Every search is charged to the workspace credit pool like a people search, and the run never spends more than the plan's cost_estimate_credits.

post/public/run-searches

Request

Base URL: https://api.bereach.ai
URL: https://api.bereach.ai/public/run-searches
Auth: HTTP bearer

Request body

plan_idstring required

The plan_id of a plan the user agreed to, exactly as it was returned. A plan runs once: calling again with the same plan_id answers where its run stands and spends nothing more.

Response

The run's receipt

plan_idstring required

addedinteger required

New rows in this list.

already_knowninteger required

People found again who are already in this list.

removedinteger

People found whom the user removed from this list earlier: left out and not added back.

list_totalinteger

The list's size after this run, the only running total.

credits_usedinteger required

Credits this run has spent so far, over every call on this plan_id.

cost_estimate_creditsinteger required

The most this run may spend: the plan's ceiling.

not_appliedstring[]

Plan fields kept for verification later, which nothing checked.

notesstring[]

The searches' own sentences, to relay as written.

running_plan_idstring

On busy: the plan whose run is going in this list.

nextstring required

Changes

Oct 22, 2026549f4adbbfcf Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added subschema #1 subschema #2 to the response body anyOf list for the response status
- info
  added the optional property to the response with the status
Oct 22, 2026bdaed6984b20 Revision changes
- warning
  removed the optional property from the response with the status

Operation history (5 revisions)