DocumentationAPI Reference
Searches

Cancel a search

Accepts a cancellation request for a cancellable job. Settlement is asynchronous: the finalize worker keeps and charges for results already produced, refunds the unused reservation, and then changes the job status to canceled. Poll the job until that terminal status is visible. Requires the searches:write scope when called with a scoped key.

POST/v1/searches/{id}/cancel

Accepts a cancellation request for a cancellable job. Settlement is asynchronous: the finalize worker keeps and charges for results already produced, refunds the unused reservation, and then changes the job status to canceled. Poll the job until that terminal status is visible. Requires the searches:write scope when called with a scoped key.

Authorization

AuthorizationBearer <token>

Pass Authorization: Bearer mapleads_xxx.

In: header

Path Parameters

id*string

Search identifier.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/searches/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{  "canceling": true}

Delete a terminal search DELETE

Deletes a job when its current state is eligible for deletion. Jobs that are still running return a conflict. Requires the `searches:write` scope when called with a scoped key.

List leads for a search GET

Returns a paginated slice of the job's extracted business leads. Enrichment fields depend on the account's current plan. Requires the `leads:read` scope when called with a scoped key.