import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const customer of conductor.qbd.customers.list({
conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
console.log(customer.id);
}import os
from conductor import Conductor
conductor = Conductor(
api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted
)
page = conductor.qbd.customers.list(
conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)curl --request GET \
--url https://api.conductor.is/v1/quickbooks-desktop/customers \
--header 'Authorization: Bearer <token>' \
--header 'Conductor-End-User-Id: <conductor-end-user-id>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Conductor-End-User-Id: <conductor-end-user-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.conductor.is/v1/quickbooks-desktop/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/customers")
.header("Conductor-End-User-Id", "<conductor-end-user-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conductor.is/v1/quickbooks-desktop/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"objectType": "list",
"url": "/v1/quickbooks-desktop/customers",
"data": [
{
"id": "80000001-1234567890",
"objectType": "qbd_customer",
"createdAt": "2025-01-01T12:34:56.000Z",
"updatedAt": "2025-02-01T12:34:56.000Z",
"revisionNumber": "1721172183",
"name": "Website Redesign Project",
"fullName": "ABC Corporation:Website Redesign Project",
"isActive": true,
"class": {
"id": "80000001-1234567890",
"fullName": "Consulting"
},
"parent": {
"id": "80000001-1234567890",
"fullName": "ABC Corporation"
},
"sublevel": 1,
"companyName": "Acme Corporation",
"salutation": "Dr.",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"jobTitle": "Purchasing Manager",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"shippingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"alternateShippingAddresses": [
{
"name": "Alternate shipping address",
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ",
"isDefaultShippingAddress": true
}
],
"phone": "+1-555-123-4567",
"alternatePhone": "+1-555-987-6543",
"fax": "+1-555-555-1212",
"email": "customer@example.com",
"ccEmail": "manager@example.com",
"contact": "Jane Smith",
"alternateContact": "Bob Johnson",
"customContactFields": [
{
"name": "Main Phone",
"value": "555-123-4567"
}
],
"additionalContacts": [
{
"id": "80000001-1234567890",
"objectType": "qbd_contact",
"createdAt": "2025-01-01T12:34:56.000Z",
"updatedAt": "2025-02-01T12:34:56.000Z",
"revisionNumber": "1721172183",
"name": "Jane Smith",
"salutation": "Dr.",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"jobTitle": "Purchasing Manager",
"customContactFields": [
{
"name": "Main Phone",
"value": "555-123-4567"
}
]
}
],
"customerType": {
"id": "80000001-1234567890",
"fullName": "Retail Customer"
},
"terms": {
"id": "80000001-1234567890",
"fullName": "Net 30"
},
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"balance": "1000.00",
"totalBalance": "5000.00",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"salesTaxItem": {
"id": "80000001-1234567890",
"fullName": "State Sales Tax"
},
"salesTaxCountry": "us",
"resaleNumber": "123456789",
"accountNumber": "1010",
"creditLimit": "5000.00",
"preferredPaymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"creditCard": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345"
},
"jobStatus": "in_progress",
"jobStartDate": "2024-01-15T00:00:00.000Z",
"jobProjectedEndDate": "2024-12-31T00:00:00.000Z",
"jobEndDate": "2024-11-30T00:00:00.000Z",
"jobDescription": "Kitchen renovation project for residential client.",
"jobType": {
"id": "80000001-1234567890",
"fullName": "Installation"
},
"note": "Our favorite customer.",
"additionalNotes": [
{
"id": 1,
"date": "2024-01-01T00:00:00.000Z",
"note": "This is a fun note."
}
],
"preferredDeliveryMethod": "email",
"priceLevel": {
"id": "80000001-1234567890",
"fullName": "Gold Member Pricing"
},
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"taxRegistrationNumber": "GB123456789",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"nextCursor": "12345678-abcd-abcd-example-1234567890ab",
"remainingCount": 10,
"hasMore": true
}List all customers
Returns a list of customers. Use the cursor parameter to paginate through the results.
IMPORTANT: If this request times out or is slow, set excludeAlternateShippingAddresses=true to significantly improve performance. Use the cursor parameter to paginate through the results.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const customer of conductor.qbd.customers.list({
conductorEndUserId: 'end_usr_1234567abcdefg',
})) {
console.log(customer.id);
}import os
from conductor import Conductor
conductor = Conductor(
api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted
)
page = conductor.qbd.customers.list(
conductor_end_user_id="end_usr_1234567abcdefg",
)
page = page.data[0]
print(page.id)curl --request GET \
--url https://api.conductor.is/v1/quickbooks-desktop/customers \
--header 'Authorization: Bearer <token>' \
--header 'Conductor-End-User-Id: <conductor-end-user-id>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.conductor.is/v1/quickbooks-desktop/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Conductor-End-User-Id: <conductor-end-user-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.conductor.is/v1/quickbooks-desktop/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Conductor-End-User-Id", "<conductor-end-user-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.conductor.is/v1/quickbooks-desktop/customers")
.header("Conductor-End-User-Id", "<conductor-end-user-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conductor.is/v1/quickbooks-desktop/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Conductor-End-User-Id"] = '<conductor-end-user-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"objectType": "list",
"url": "/v1/quickbooks-desktop/customers",
"data": [
{
"id": "80000001-1234567890",
"objectType": "qbd_customer",
"createdAt": "2025-01-01T12:34:56.000Z",
"updatedAt": "2025-02-01T12:34:56.000Z",
"revisionNumber": "1721172183",
"name": "Website Redesign Project",
"fullName": "ABC Corporation:Website Redesign Project",
"isActive": true,
"class": {
"id": "80000001-1234567890",
"fullName": "Consulting"
},
"parent": {
"id": "80000001-1234567890",
"fullName": "ABC Corporation"
},
"sublevel": 1,
"companyName": "Acme Corporation",
"salutation": "Dr.",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"jobTitle": "Purchasing Manager",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"shippingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"alternateShippingAddresses": [
{
"name": "Alternate shipping address",
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ",
"isDefaultShippingAddress": true
}
],
"phone": "+1-555-123-4567",
"alternatePhone": "+1-555-987-6543",
"fax": "+1-555-555-1212",
"email": "customer@example.com",
"ccEmail": "manager@example.com",
"contact": "Jane Smith",
"alternateContact": "Bob Johnson",
"customContactFields": [
{
"name": "Main Phone",
"value": "555-123-4567"
}
],
"additionalContacts": [
{
"id": "80000001-1234567890",
"objectType": "qbd_contact",
"createdAt": "2025-01-01T12:34:56.000Z",
"updatedAt": "2025-02-01T12:34:56.000Z",
"revisionNumber": "1721172183",
"name": "Jane Smith",
"salutation": "Dr.",
"firstName": "John",
"middleName": "A.",
"lastName": "Doe",
"jobTitle": "Purchasing Manager",
"customContactFields": [
{
"name": "Main Phone",
"value": "555-123-4567"
}
]
}
],
"customerType": {
"id": "80000001-1234567890",
"fullName": "Retail Customer"
},
"terms": {
"id": "80000001-1234567890",
"fullName": "Net 30"
},
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"balance": "1000.00",
"totalBalance": "5000.00",
"salesTaxCode": {
"id": "80000001-1234567890",
"fullName": "Non"
},
"salesTaxItem": {
"id": "80000001-1234567890",
"fullName": "State Sales Tax"
},
"salesTaxCountry": "us",
"resaleNumber": "123456789",
"accountNumber": "1010",
"creditLimit": "5000.00",
"preferredPaymentMethod": {
"id": "80000001-1234567890",
"fullName": "Credit Card"
},
"creditCard": {
"number": "xxxxxxxxxxxx1234",
"expirationMonth": 12,
"expirationYear": 2024,
"name": "John Doe",
"address": "1234 Main St, Anytown, USA, 12345",
"postalCode": "12345"
},
"jobStatus": "in_progress",
"jobStartDate": "2024-01-15T00:00:00.000Z",
"jobProjectedEndDate": "2024-12-31T00:00:00.000Z",
"jobEndDate": "2024-11-30T00:00:00.000Z",
"jobDescription": "Kitchen renovation project for residential client.",
"jobType": {
"id": "80000001-1234567890",
"fullName": "Installation"
},
"note": "Our favorite customer.",
"additionalNotes": [
{
"id": 1,
"date": "2024-01-01T00:00:00.000Z",
"note": "This is a fun note."
}
],
"preferredDeliveryMethod": "email",
"priceLevel": {
"id": "80000001-1234567890",
"fullName": "Gold Member Pricing"
},
"externalId": "12345678-abcd-1234-abcd-1234567890ab",
"taxRegistrationNumber": "GB123456789",
"currency": {
"id": "80000001-1234567890",
"fullName": "USD"
},
"customFields": [
{
"ownerId": "0",
"name": "Customer Rating",
"type": "string_1024_type",
"value": "Premium"
}
]
}
],
"nextCursor": "12345678-abcd-abcd-example-1234567890ab",
"remainingCount": 10,
"hasMore": true
}Authorizations
Headers
Query Parameters
Filter for specific customers 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 customers by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for a customer, formed by by combining the names of its parent objects with its own name, separated by colons. For example, if a customer is under "ABC Corporation" and has the name "Website Redesign Project", its fullName would be "ABC Corporation:Website Redesign Project".
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.
["ABC Corporation:Website Redesign Project"]
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.
1 <= x <= 150150
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.
IMPORTANT: The cursor is the same value for every page, and requests that send it are not idempotent: each one returns the next page. Send each request within 20 seconds of the previous response. If you miss that window or a request fails, start over without a cursor. To make a run resumable, see Paging by name.
"12345678-abcd-abcd-example-1234567890ab"
Filter for customers updated on or after this date/time. Accepts the following ISO 8601 formats:
- date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g.,
2025-01-01→2025-01-01T00:00:00). - datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
- datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
"2025-01-01T12:34:56.000Z"
Filter for customers updated on or before this date/time. Accepts the following ISO 8601 formats:
- date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g.,
2025-01-01→2025-01-01T23:59:59). - datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
- datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.
"2025-02-01T12:34:56.000Z"
Filter for customers whose fullName starts with this substring, case-insensitive. To get everything under a parent, pass the parent's fullName followed by a colon, such as "ABC:". Records under a parent are not matched by the start of their own name; use nameContains.
NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.
"ABC"
Filter for customers whose fullName sorts at or after this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters.
When you set nameFrom or nameTo, QuickBooks returns customers sorted by fullName in that order; without either, the order is not guaranteed. To page through customers by name, see Paging by name.
NOTE: If you use this parameter, you cannot also use nameContains, nameStartsWith, or nameEndsWith.
"A"
Filter for customers whose fullName sorts at or before this value (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation first, then digits, then letters. If you also set nameFrom, it must not sort after this value, or QuickBooks returns an error.
When you set nameFrom or nameTo, QuickBooks returns customers sorted by fullName in that order; without either, the order is not guaranteed.
NOTE: If you use this parameter, you cannot also use nameContains, nameStartsWith, or nameEndsWith.
"Z"
Excludes alternate shipping addresses from each customer returned by the list request. When true, the response returns alternateShippingAddresses as null instead of fetching the address array. Use this when your integration does not need alternate shipping addresses. This significantly improves performance for company files where some customers have many saved shipping addresses (sometimes dozens or hundreds).
true
Response
Returns a list of customers.
The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.
NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.
"12345678-abcd-abcd-example-1234567890ab"

