Search Employees

Search for employees in NetSuite.

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First Matching Record: Returns the first record that matches. First 200 Matching Records: Returns the first 200 matching records. Stream Matching Records: Passes all matching records from your parent flow to a helper flow. Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.	Dropdown	TRUE
Filter	Choose one of the following filter options to search for employees where the selected attributes match: Is Empty - Is Not Empty: The selected attributes are either empty or not empty. Equal: The selected attributes are equal to the provided values. Not Equal: The selected attributes aren't equal to the provided values. Contains: The selected attributes contain the provided values. Does Not Contain: The selected attributes don't contain the provided values. After Date: The selected attributes have a date older than the provided values. Before Date: The selected attributes have a date earlier than the provided values.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose a method to filter search results:

First Matching Record: Returns the first record that matches.
First 200 Matching Records: Returns the first 200 matching records.
Stream Matching Records: Passes all matching records from your parent flow to a helper flow.

Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown

TRUE

Filter

Choose one of the following filter options to search for employees where the selected attributes match:

Is Empty - Is Not Empty: The selected attributes are either empty or not empty.
Equal: The selected attributes are equal to the provided values.
Not Equal: The selected attributes aren't equal to the provided values.
Contains: The selected attributes contain the provided values.
Does Not Contain: The selected attributes don't contain the provided values.
After Date: The selected attributes have a date older than the provided values.
Before Date: The selected attributes have a date earlier than the provided values.

Dropdown

TRUE

To learn how to return large numbers of records, see Stream matching records with a helper flow.

Input

Empty input fields are removed from the search query before the request. Use the Is Empty - Is Not Empty option to search for employees with empty attributes.
Fields representing a date value must use the following format: MM/DD/YYYY.

Field	Definition	Type	Required
Fields
Entity ID	Unique identifier for the employee record. This is shown as the Employee ID in the NetSuite interface.	Text	FALSE
External ID	The external ID of the employee.	Text	FALSE
First Name	The first name of the employee.	Text	FALSE
Middle Name	The middle name of the employee.	Text	FALSE
Last Name	The last name of the employee.	Text	FALSE
Email	The email of the employee.	Text	FALSE
Is Inactive	Specifies whether the employee is inactive.	True/False	FALSE
Initials	The initials of the employee.	Text	FALSE
Gender	The gender of the employee. Blank: Use an empty value for the field. Not Specified: The employee's gender field is explicitly unspecified. Non-Binary: The employee identifies as non-binary. Male: The employee identifies as a male. Female: The employee identifies as a female.	Dropdown	FALSE
Job Title	The official job title of the employee.	Text	FALSE
Job Description	The description of the duties this person currently performs.	Text	FALSE
Supervisor ID	The ID of the employee's supervisor. To find the ID of the supervisor, open your NetSuite center and go to ListsEmployeesEmployees. Use the Internal ID value.	Text	FALSE
Time Approver ID	The ID of the person who approves the employee's time transactions. To find the ID of the required person, open your NetSuite center and go to ListsEmployeesEmployees. Use the Internal ID value.	Text	FALSE
Notes	Any comments included on the employee's record.	Text	FALSE
Phone	The phone number for the employee.	Text	FALSE
Office Phone	The office phone number of the employee.	Text	FALSE
Mobile Phone	The mobile phone number of the employee.	Text	FALSE
Home Phone	The home phone number of the employee.	Text	FALSE
Fax	The fax number for the employee.	Text	FALSE
Department ID	The ID of the employee's department. To find the ID of the department, go to SetupCompanyDepartments. Use the Internal ID value.	Text	FALSE
Subsidiary ID	The ID of the employee's subsidiary. To find the ID of the subsidiary, go to SetupCompanySubsidiaries. Use the Internal ID value.	Text	FALSE
Class ID	The ID of the employee's class. To find the ID of the class, go to: SetupCompanyClasses. Use the Internal ID value.	Text	FALSE
Location ID	The ID of the employee's location. To find the ID of the location, go to SetupCompanyLocations. Use the Internal ID value.	Text	FALSE
Birth Date	The employee's birth date.	Text	FALSE
Employee Type ID	The ID of the employee's type. To find the ID of the type, go to SetupAccountingEmployee Related ListsEmployee Type. Use the Internal ID value.	Text	FALSE
Employee Status ID	The ID of the employee's status. To find the ID of the status, go to SetupAccountingEmployee Related ListsEmployee Status. Use the Internal ID value.	Text	FALSE
Is Sales Representative	Identifies whether the employee is a sales representative or not.	True/False	FALSE
Is Support Representative	Identifies whether the employee is a support representative or not.	True/False	FALSE
Hire Date	The date this employee was hired.	Text	FALSE
Last Review Date	The date of the employee's last salary evaluation.	Text	FALSE
Next Review Date	The date of the employee's next salary evaluation.	Text	FALSE
Termination Date	The employee's final date of employment.	Text	FALSE
Default Job Resource Role ID	The ID of the employee's default job resource role. To find the ID of the default job resource role, go to SetupAccountingProject Resource Roles. Use the Internal ID value.	Text	FALSE
Account	The account number for the employee's benefits provider.	Text	FALSE
Alien Number	The alien number of the employee.	Text	FALSE
Visa Expiration Date	The expiration date of the employee's visa.	Text	FALSE
Authorized To Work Until	The last date that the employee is authorized to work.	Text	FALSE
Custom
Filter	To make your search more flexible, provide an employee API attribute name with a filter operator. If you use the Custom Filter field with other input fields, its value must start with the AND or OR logical operator. If you only use the Custom Filter field, its value can't start with the AND or OR logical operator. See the Employee Record API attributes and Record Collection Filtering for a full list of available attributes and filter operators.	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. This field appears when you select Stream Matching Records from the Result Set option. The input field on the Helper Card in the streaming helper flow must reference the key Record (type object) to obtain streamed records. To obtain state input values, reference the key State (type object) of the Record object.	Flow	TRUE
Record Limit	Specify the number of records to stream. The Record Limit field can't be set to 0. When the Record Limit field is set to greater than 1, the stream returns up to the maximum number specified. When the Record Limit field is null or not selected, the stream returns all records. The default value is 500000. The valid range is from 1 to 500000. This field appears when you select Stream Matching Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
ID	The ID of the employee.	Text
Employees		List of Objects
ID	The ID of the employee.	Text
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Matching Records from the Result Set option.	Number

Search Employees

Options

Input

Output

Related topics