This endpoint lets you fetch a candidate under a task of your organization. More information about the candidate can be obtained using keywords in the body.
Request Body
A list of keywords can be provided with the expand property in the request body. For each keyword provided, extra information about the candidate will be returned in the response.
{
expand: ("initiator" | "externalId" | "notes" | "extraEmails")[];
}Response
By default, a "detailed" candidate object will be returned. Additional properties can will be added on top of the detailed object.
Detailed & {
initiator?: "manual" | "create-or-update" | "link" | "api" | "rest-api";
externalId?: string;
notes?: string;
extraEmails?: string[]; // email addresses
}- initiator: the method by which the candidate was created. "link" is associated with "self-registration" source, others are associated with "pre-registration".
- externalId: The Id by which the candidate is known or identified by in other platforms. This can be assigned to a candidate at the time of their creation via API.
- notes: The notes attached to the candidate
- extraEmails: The additional email addresses that will be notified when the candidate completes a test session if the appropriate automated email settings are configured.