Sign in

v2

latestOpenAPI 3.1.02026-08-0858116535.1 KB
Searches

Cancel a running Search

Cancels a currently running Search.

You can cancel all searches at once by using the websets/:webset/cancel endpoint.

post/v0/websets/{webset}/searches/{id}/cancel

Path parameters

websetstring required

The id of the Webset

idstring required

The id of the Search

Response

Search canceled

idstring required

The unique identifier for the search

object'webset_search' required
status'created' | 'pending' | 'running' | 'completed' | 'canceled' required

The status of the search

websetIdstring required

The unique identifier for the Webset this search belongs to

querystring required

The query used to create the search.

countnumber required

The number of results the search will attempt to find. The actual number of results may be less than this number depending on the search complexity.

maxPeoplePerCompanyinteger nullable required

The soft cap requested for matching people from the same current employer company, or null when no cap was requested.

behavior'override' | 'append'
metadataobject

Set of key-value pairs you want to associate with this object.

canceledAtstring date-time nullable required

The date and time the search was canceled

canceledReason'webset_deleted' | 'webset_canceled' | 'out_of_credits' required
createdAtstring date-time required

The date and time the search was created

updatedAtstring date-time required

The date and time the search was updated