API Reference

candidate.searchSuggestions

post
https://api.ashbyhq.com/candidate.searchSuggestions

Searches for candidates by email and/or name and returns a minimal suggestion shape for typeahead use cases.

Requires the candidatesRead permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

The candidate's email

string
length ≥ 1

The candidate's name

integer
≤ 100

The maximum number of candidate suggestions to return. Defaults to 10 and cannot exceed 100.

Response

Updated 1 day ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago