GET
/
quickbooks-desktop
/
employees
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const employee of conductor.qbd.employees.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {
  console.log(employee.id);
}
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/employees",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_employee",
      "createdAt": "2021-10-01T12:34:56-05:00",
      "updatedAt": "2021-10-01T15:45:30-05:00",
      "revisionNumber": "1721172183",
      "name": "John Doe",
      "isActive": true,
      "salutation": "Dr.",
      "firstName": "John",
      "middleName": "A.",
      "lastName": "Doe",
      "jobTitle": "Purchasing Manager",
      "supervisor": {
        "id": "80000001-1234567890",
        "fullName": "John Doe"
      },
      "department": "Sales",
      "description": "This employee is a key employee.",
      "targetBonus": "10000.00",
      "address": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States"
      },
      "printAs": "John Doe",
      "phone": "+1-555-123-4567",
      "mobile": "+1-555-555-1212",
      "pager": "+1-555-555-1212",
      "pagerPin": "1234",
      "alternatePhone": "+1-555-987-6543",
      "fax": "+1-555-555-1212",
      "ssn": "123-45-6789",
      "email": "employee@example.com",
      "customContactFields": [
        {
          "name": "Main Phone",
          "value": "555-123-4567"
        }
      ],
      "emergencyContact": {
        "primaryContact": {
          "name": "Main Phone",
          "value": "555-123-4567",
          "relation": "spouse"
        },
        "secondaryContact": {
          "name": "Main Phone",
          "value": "555-123-4567",
          "relation": "spouse"
        }
      },
      "employeeType": "regular",
      "employmentStatus": "full_time",
      "overtimeExemptStatus": "exempt",
      "keyEmployeeStatus": "key_employee",
      "gender": "male",
      "hiredDate": "2024-01-01",
      "originalHireDate": "2024-01-01",
      "adjustedServiceDate": "2024-01-01",
      "terminationDate": "2024-01-01",
      "birthDate": "1990-01-01",
      "usCitizenshipStatus": "citizen",
      "ethnicity": "asian",
      "disabilityStatus": "disabled",
      "disabilityDescription": "Cerebral Palsy",
      "i9OnFileStatus": "on_file",
      "workAuthorizationExpirationDate": "2024-01-01",
      "usVeteranStatus": "veteran",
      "militaryStatus": "active",
      "accountNumber": "1010",
      "note": "This employee is a key employee.",
      "additionalNotes": [
        {
          "id": 1,
          "date": "2021-01-01",
          "note": "This is a fun note."
        }
      ],
      "billingRate": {
        "id": "80000001-1234567890",
        "fullName": "Standard Rate"
      },
      "employeePayroll": {
        "payPeriod": "weekly",
        "class": {
          "id": "80000001-1234567890",
          "fullName": "Payroll"
        },
        "earnings": [
          {
            "payrollWageItem": {
              "id": "80000001-1234567890",
              "fullName": "Regular Pay"
            },
            "rate": "10.00",
            "ratePercent": "10.5"
          }
        ],
        "useTimeDataToCreatePaychecks": "uses_time_data",
        "sickHours": {
          "hoursAvailable": "PT8H30M",
          "accrualPeriod": "accrues_per_paycheck",
          "hoursAccruedPerPeriod": "PT8H0M",
          "maximumHours": "PT80H0M",
          "resetsHoursEachYear": false,
          "hoursUsed": "PT2H45M",
          "accrualStartDate": "2024-01-01"
        },
        "vacationHours": {
          "hoursAvailable": "PT8H30M",
          "accrualPeriod": "accrues_per_paycheck",
          "hoursAccruedPerPeriod": "PT8H0M",
          "maximumHours": "PT80H0M",
          "resetsHoursEachYear": false,
          "hoursUsed": "PT2H45M",
          "accrualStartDate": "2024-01-01"
        }
      },
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Query Parameters

​
ids
string[]

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.

Example:
["80000001-1234567890"]
​
names
string[]

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.

Example:
["John Doe"]
​
limit
integer
default:150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Required range: 1 <= x <= 150
Example:

150

​
cursor
string

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

Example:

"12345678-abcd-abcd-example-1234567890ab"

​
status
enum<string>
default:active

Filter for employees that are active, inactive, or both.

Available options:
active,
all,
inactive
Example:

"active"

​
updatedAfter
string

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.

Example:

"2021-01-01T12:34:56"

​
updatedBefore
string

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.

Example:

"2021-02-01T12:34:56"

​
nameContains
string

Filter for employees whose name contains this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

Example:

"ABC"

​
nameStartsWith
string

Filter for employees whose name starts with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

Example:

"ABC"

​
nameEndsWith
string

Filter for employees whose name ends with this substring, case-insensitive.

NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

Example:

"ABC"

​
nameFrom
string

Filter for employees whose name is alphabetically greater than or equal to this value.

Example:

"A"

​
nameTo
string

Filter for employees whose name is alphabetically less than or equal to this value.

Example:

"Z"

Response

200 - application/json

Returns a list of employees.

The response is of type object.