Returns a list of employees. NOTE: QuickBooks Desktop does not support pagination for employees; hence, there is no cursor
parameter. Users typically have few employees.
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
"end_usr_1234567abcdefg"
Filter for specific employees by their QuickBooks-assigned unique identifier(s).
IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.
NOTE: If any of the values you specify in this parameter are not found, the request will return an error.
["80000001-1234567890"]
Filter for specific employees by their name(s), case-insensitive. Like id
, name
is a unique identifier for an employee.
IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.
NOTE: If any of the values you specify in this parameter are not found, the request will return an error.
["John Doe"]
The maximum number of objects to return.
IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for employees. This parameter will limit the response size, but you cannot fetch subsequent results using a cursor. For pagination, use the name-range parameters instead (e.g., nameFrom=A&nameTo=B
).
When this parameter is omitted, the endpoint returns all employees without limit, unlike paginated endpoints which default to 150 records. This is acceptable because employees typically have low record counts.
x >= 1
10
Filter for employees that are active, inactive, or both.
active
, all
, inactive
"active"
Filter for employees updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.
"2021-01-01T12:34:56"
Filter for employees updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.
"2021-02-01T12:34:56"
Filter for employees whose name
contains this substring, case-insensitive.
NOTE: If you use this parameter, you cannot also use nameStartsWith
or nameEndsWith
.
"ABC"
Filter for employees whose name
starts with this substring, case-insensitive.
NOTE: If you use this parameter, you cannot also use nameContains
or nameEndsWith
.
"ABC"
Filter for employees whose name
ends with this substring, case-insensitive.
NOTE: If you use this parameter, you cannot also use nameContains
or nameStartsWith
.
"ABC"
Filter for employees whose name
is alphabetically greater than or equal to this value.
"A"
Filter for employees whose name
is alphabetically less than or equal to this value.
"Z"
Returns a list of employees.
The response is of type object
.