Starhunter icon

Starhunter

Interact with Starhunter

Actions12

Candidate → Search

AI-generated

Summary

Search candidates using optional filters such as candidate ID, partial name match, and birth date (MM-DD format). Supports pagination through limit and offset parameters.

Inputs

  • Candidate ID — Filter search results to a specific candidate's ID.
  • Name — Filter search results by candidate name with partial matching.
  • Birth Date — Filter candidates by their birth date, specified in MM-DD format.
  • Limit — Maximum number of candidate records to return, between 1 and 1000 (default 50).
  • Offset — Number of candidate records to skip from the beginning, for pagination (default 0).

Output shape

a list of candidate records matching the filters, each containing fields such as id, name, firstName, secondName, middleName, academicTitle, salutation, email, birthDate, availableFrom, phone, functions, address, createdAt, updatedAt, and contactHistory (with title, type, and date).

If no filters are provided, returns up to the limit number of candidates. Pagination can be controlled using limit and offset. Errors returned by the API will throw NodeApiError exceptions.

Links

Discussion