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>

Email to look up. Lowercased and trimmed before matching.

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>
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[]