Skip to main content
GET
Get ownership search results
Read the current state of a batch owned by the authenticated account. Poll until status is succeeded or failed.
A succeeded batch includes the complete result document in result, including result.summary, result.credits_charged, and one result per submitted location. The result is returned inline; there is no separate download endpoint. Polling is not billed. Every result includes customer_record_id and the submitted restaurant, including unmatched results. The API returns 404 both when the batch does not exist and when it belongs to another account.

Authorizations

X-API-Key
string
header
required

Path Parameters

batch_id
string
required

Batch identifier returned by the create endpoint.

Required string length: 7 - 200
Pattern: ^batch_[0-9a-f]+$

Response

Current batch state.

batch_id
string
required
Required string length: 7 - 200
Pattern: ^batch_[0-9A-Za-z]+$
location_count
integer
required
Required range: 1 <= x <= 500
created_at
string<date-time>
required
status
string
required
Allowed value: "queued"
type
string
default:local_business_batch
Allowed value: "local_business_batch"