Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your organization API key, available in Organisation settings.

Path Parameters

searchId
string
required

Unique identifier of the search returned when it was launched

Response

Search status retrieved successfully

searchId
string
required

Unique identifier of the search

Example:

"cm71yqftr00000ck0bpz3hpg1"

status
enum<string>
required

Current status of the search

Available options:
ONGOING,
COMPLETED,
FAILED
Example:

"COMPLETED"

results
object[] | null
required

Ranked results. Null until the search reaches COMPLETED; then an array (possibly empty) ordered by descending match score and capped at the org per-call limit (30 by default).