Skip to main content

Search Invite Candidates

GET 

/public-api/v1/employees/invite-candidates

EndPoint Description : Returns a paginated list of people in the authenticated organization who can be invited as an existing employee. Use this before POST /employees/invites/existing. Pass the returned userId as the existing user to invite.

Details :

  • Required query userType selects the source: employees (Employee ledger), directory (Membership ledger), officers, or shareholders.
  • Optional search filters by name or email. Results are paged with $page, $perPage, $orderBy, and $order.
  • Each item includes userId, name, email, and jobTitle. Officers and shareholders may also include attestationStatus.
  • Records without a resolvable userId are omitted from the response.

Request

Responses

Employees fetched successfully