FindAll

Stream FindAll Events

Stream events from a FindAll run.

Args: request: The Shapi request findall_id: The FindAll run ID last_event_id: Optional event ID to resume from. timeout: Optional timeout in seconds. If None, keep connection alive as long as the run is going. If set, stop after specified duration.

get/v1beta/findall/runs/{findall_id}/events

Path parameters

findall_idstring required

Query parameters

last_event_idstring nullable

timeoutnumber nullable

Headers

parallel-betastring nullable

Response

Successful Response

Changes

Changed in 5 of the 21 revisions of this API.1136

Jun 8, 2026973957d74ceb1See the full diff
- ○
  header request parameter parallel-beta was deprecated
  request-parameter-deprecated
Apr 21, 202657e1c56be0942See the full diff
- ○
  api tag FindAll added
  api-tag-added
- ○
  api tag FindAll API (Beta) removed
  api-tag-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 9, 2026970b780e86491See the full diff
- ●
  added the new insufficient_funds enum value to the oneOf[subschema #2: FindAllRunStatusEvent]/data/status/termination_reason/anyOf[subschema #1]/ response property for the response status 200
  response-property-enum-value-added
Jan 13, 2026105d778ad64d132See the full diff
- ▲
  the error response's property type/format changed from / to object/ for status 404
  response-property-type-changed
- ○
  added the optional property error/detail to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/enrichments to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/generator to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/match_limit to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #2: FindAllRunStatusEvent]/data/created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #2: FindAllRunStatusEvent]/data/metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #2: FindAllRunStatusEvent]/data/modified_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/basis to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/description to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/output to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oneOf[subschema #4: ErrorEvent]/error/detail to the response with the 200 status
  response-optional-property-added
- ○
  removed Error from the error response property allOf list for the response status 404
  response-property-all-of-removed
- ○
  removed Error from the oneOf[subschema #4: ErrorEvent]/error response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  removed FindAllCandidate from the oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  removed FindAllRun from the oneOf[subschema #2: FindAllRunStatusEvent]/data response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  removed FindAllSchema from the oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  removed the error enum value from the oneOf[subschema #4: ErrorEvent]/type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the error enum value from the type response property for the response status 404
  response-property-enum-value-removed
- ○
  added the required property error/message to the response with the 404 status
  response-required-property-added
- ○
  added the required property error/ref_id to the response with the 404 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/entity_type to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/match_conditions to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #1: FindAllSchemaUpdatedEvent]/data/objective to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #2: FindAllRunStatusEvent]/data/findall_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #2: FindAllRunStatusEvent]/data/generator to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #2: FindAllRunStatusEvent]/data/status to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/candidate_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/match_status to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/name to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #3: FindAllCandidateMatchStatusEvent]/data/url to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #4: ErrorEvent]/error/message to the response with the 200 status
  response-required-property-added
- ○
  added the required property oneOf[subschema #4: ErrorEvent]/error/ref_id to the response with the 200 status
  response-required-property-added
This revision also has 19 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 13, 202570ca78f3dbac1See the full diff
- ○
  endpoint added
  endpoint-added

Full history