Endpoint: Listing Candidates

This endpoint lets you fetch multiple candidates under a task of your organization. You can manage pagination and apply filters in you request with query parameters.

• fullname: Search candidate by their full name (case sensitive). Works with exact match.
• email: Search candidate by their email (case sensitive). Works with exact match.
• code: Search candidate by their code (case sensitive). Works with exact match.

Response

{
  candidates: (Basic | Detailed)[];
  pagination: {
    totalItems: number;
    totalPages: number;
    currentPage: number;
    limit: number;
    next: string | null;
    previous: string | null;
  }
}

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

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;
    directAccessUrl: 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"; // source
  active: boolean;
  activeAfter: number | null; // seconds
  activeBefore: number  | null; // seconds

  group: string;
  tags: Record;
  labels: string[];

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