Employees
Retrieve an employee
QuickBooks Desktop API
Core Resources
- Auth Sessions
- End Users
Utilities
Transactions
- All Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Inventory Adjustments
- Invoices
- Item Receipts
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Time Tracking Activities
- Transfers
- Vendor Credits
General
- Account Tax Lines
- Accounts
- Classes
- Company
- Customers / Jobs
- Date-Driven Terms
- Employees
- Inventory Sites
- Payment Methods
- Payroll Wage Items
- Preferences
- Price Levels
- Sales Representatives
- Sales-Tax Codes
- Standard Terms
- Vendors
Items
- Discount Items
- Inventory Assembly Items
- Inventory Items
- Item Groups
- Item Sites
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Employees
Retrieve an employee
Retrieves an employee by ID.
GET
/
quickbooks-desktop
/
employees
/
{id}
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const employee = await client.qbd.employees.retrieve('80000001-1234567890', {
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(employee.id);
}
main();
{
"id": "80000001-1234567890",
"objectType": "qbd_employee",
"createdAt": "2021-10-01T17:34:56.000Z",
"updatedAt": "2021-10-01T20:45:30.000Z",
"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"
}
]
}
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Example:
"end_usr_1234567abcdefg"
Path Parameters
The QuickBooks-assigned unique identifier of the employee to retrieve.
Example:
"80000001-1234567890"
Response
200 - application/json
Returns the specified employee.
The response is of type object
.
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const employee = await client.qbd.employees.retrieve('80000001-1234567890', {
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(employee.id);
}
main();
{
"id": "80000001-1234567890",
"objectType": "qbd_employee",
"createdAt": "2021-10-01T17:34:56.000Z",
"updatedAt": "2021-10-01T20:45:30.000Z",
"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"
}
]
}