Endpoint: Fetching a Candidate

This endpoint lets you fetch a candidate under a task by its id.

With the "mode" parameter, you can choose to receive a smaller or a bigger candidate object depending on your needs.

Response

If the value of mode is "basic", you will receive: 

// "basic" candidate object
{
    candidateId: string;
    kind: "user" | "temp"; // internal or temporary candidate
    taskId: string;
    loggedIn: boolean;
    fullname?: string;
    email?: string;
    invitationCode: string | null;// null for kind: "user"
}

If the value of mode is "detailed", you will receive all of the properties from "basic" and also these properties:

// "detailed" candidate object:
Basic & {  
  organizationId: string;
  source: "self-registration" | "pre-registration";
  active: boolean;
  activeAfter: number | null; // seconds
  activeBefore: number  | null; // seconds

  group: string;
  tags: Record<
    string,
    string
  >;
  labels: string[];

  rating: 1 | 2 | 3 | 4 | 5 | null;
  stage: string | null;
}

• source: Whether a candidate was registered by the organization or the candidate self-registered at the start of an assessment.
• rating: 1-5 rating assigned to the candidate by the organization.
• stage: The custom stage value assigned to the candidate by the organiztion.