Starhunter icon

Starhunter

Interact with Starhunter

Actions12

Employee → Search

AI-generated

Summary

Search employees by optional filters such as specific employee ID or partial name match, and paginate results.

Inputs

  • Employee ID — Search by specific employee ID
  • Name — Search by employee name (partial match)
  • Limit — Maximum number of results to return, between 1 and 1000 (default 50)
  • Offset — Number of results to skip for pagination (default 0)

Output shape

a list of employee records

Each employee object includes fields like id, name, email, birthDate, phone, functions, address, createdAt, updatedAt, and contactHistory. Supports pagination via limit and offset parameters. Returns empty list if no matches are found. Errors during execution will throw a NodeApiError.

Examples

Example 1: Search employees named 'John' and return the first 20 results

Set Name to 'John', Limit to 20, leave Employee ID and Offset empty or at defaults.

Links

Discussion