Skip to main content
GET
Look up candidates by email or phone

Authorizations

Authorization
string
header
required

HTTP Basic Authentication with API credentials

Query Parameters

email
string

Email to look up. Only trimmed and lowercased (no format check); a blank value is rejected.

phone
string

Phone to look up. Parsed to E.164 before matching.

Response

Matching candidates (up to 50)

_status
enum<string>
Available options:
OK
_self
string<uri-reference>
normalized_email
string | null

The email after normalization, or null when it could not be normalized.

normalized_phone
string | null

The phone after E.164 parsing, or null when it could not be parsed.

rejected_criteria
enum<string>[]

Criteria that were supplied but could not be normalized.

Available options:
email,
phone
items
object[]