Endpoint: Listing Candidates

Endpoint: Listing Candidates
February, 2025
GET /api/integration/rest/v1/tasks/:taskId/candidates

This endpoint lets you fetch multiple candidates under a task of your organization. You can apply pagination and filters using query paramters.

Query ParametersExpected TypeDefault
mode"basic" | "detailed""basic"
limitnumber10
pagenumber1
fullnamestring
codestring
uniqIdstring

Response

{
  candidates: (Basic | Detailed)[];
  pagination: {
    totalItems: number;
    totalPages: number;
    currentPage: number;
    limit: number;
    next: string | null;
    previous: string | null;
  }
}
Go Back
Talk to a representative
Figure out if TestInvite is a good match for your organization
Book a demo