List all customers - Conductor Docs

QuickBooks Desktop API

Welcome to Conductor's new QuickBooks Desktop API (beta)

Core Resources

Accounts
Classes
Customers
Date-Driven Terms
Inventory Sites
Sales-Tax Codes
Standard Terms
Vendors

Transactions

Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Invoices
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Transfers

Items

Inventory Assembly Items
Inventory Items
Non-Inventory Items
Sales-Tax Items
Service Items

GET

quickbooks-desktop

customers

ids

array

fullNames

array

limit

integer

cursor

string

status

enum<string>

updatedAfter

string

updatedBefore

string

nameContains

string

nameStartsWith

string

nameEndsWith

string

nameFrom

string

nameTo

string

totalBalance

string

totalBalanceGreaterThan

string

totalBalanceGreaterThanOrEqualTo

string

totalBalanceLessThan

string

totalBalanceLessThanOrEqualTo

string

currencyIds

array

classIds

array

Authorizations

Authorization

string

headerrequired

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}}").

Query Parameters

ids

string[]

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.

fullNames

string[]

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.

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

cursor

string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

status

enum<string>

default: active

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

Available options:

active,

all,

inactive

updatedAfter

string

Filter for customers 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.

updatedBefore

string

Filter for customers 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.

nameContains

string

Filter for customers whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

nameStartsWith

string

Filter for customers whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

nameEndsWith

string

Filter for customers whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

nameFrom

string

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

nameTo

string

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

totalBalance

string

Filter for customers whose totalBalance equals this amount, represented as a decimal string. You can only use one total-balance filter at a time.

totalBalanceGreaterThan

string

Filter for customers whose totalBalance is greater than this amount, represented as a decimal string. You can only use one total-balance filter at a time.

totalBalanceGreaterThanOrEqualTo

string

Filter for customers whose totalBalance is greater than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.

totalBalanceLessThan

string

Filter for customers whose totalBalance is less than this amount, represented as a decimal string. You can only use one total-balance filter at a time.

totalBalanceLessThanOrEqualTo

string

Filter for customers whose totalBalance is less than or equal to this amount, represented as a decimal string. You can only use one total-balance filter at a time.

currencyIds

string[]

Filter for customers in these currencies.

classIds

string[]

Filter for customers of these classes. A class is a way end-users can categorize customers in QuickBooks.

Response

200 - application/json

objectType

string

required

The type of object. This value is always "list".

Allowed value: "list"

url

string

required

The endpoint URL where this list can be accessed.

data

object[]

required

The array of customers.

data.id

string

required

The unique identifier assigned by QuickBooks to this customer. This ID is unique across all customers but not across different QuickBooks object types.

data.objectType

string

required

The type of object. This value is always "qbd_customer".

Allowed value: "qbd_customer"

data.createdAt

string

required

The date and time when this customer was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.updatedAt

string

required

The date and time when this customer was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.revisionNumber

string

required

The current revision number of this customer object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

data.name

string

required

The case-insensitive name of this customer. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two customers could both have the name "Website Redesign Project", but they could have unique fullName values, such as "ABC Corporation:Website Redesign Project" and "Baker:Website Redesign Project". Maximum length: 41 characters.

data.fullName

string

required

The case-insensitive fully-qualified unique name of this customer, formed by combining the names of its hierarchical 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".

NOTE: Unlike name, fullName is guaranteed to be unique across all customer objects. However, fullName can still be arbitrarily changed by the QuickBooks user when they modify the underlying name field.

IMPORTANT: If this object is a job (i.e., a sub-customer), this value would likely be the job's name prefixed by the customer's name.

data.isActive

boolean

required

Indicates whether this customer is active. Inactive objects are typically hidden from views and reports in QuickBooks.

data.class

object | null

required

The customer's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default.

data.parent

object | null

required

The parent customer one level above this one in the hierarchy. For example, if this customer has a fullName of "ABC Corporation:Website Redesign Project", its parent has a fullName of "ABC Corporation". If this customer is at the top level, this field will be null.

data.sublevel

number

required

The depth level of this customer in the hierarchy. A top-level customer has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, a customer with a fullName of "ABC Corporation:Website Redesign Project" would have a sublevel of 1. When sublevel is 0, this object is a customer; when sublevel is greater than 0, this object is typically a job (i.e., a sub-customer).

data.companyName

string | null

required

The name of the company associated with this customer. This name is used on invoices, checks, and other forms.

data.salutation

string | null

required

The formal salutation title that precedes the name of the contact person for this customer, such as "Mr.", "Ms.", or "Dr.".

data.firstName

string | null

required

The first name of the contact person for this customer.

data.middleName

string | null

required

The middle name of the contact person for this customer.

data.lastName

string | null

required

The last name of the contact person for this customer.

data.jobTitle

string | null

required

The job title of the contact person for this customer.

data.billingAddress

object | null

required

The customer's billing address.

data.shippingAddress

object | null

required

The customer's shipping address.

data.alternateShippingAddresses

object[]

required

A list of additional shipping addresses for this customer. Useful when the customer has multiple shipping locations.

data.phone

string | null

required

The customer's primary telephone number.

data.alternatePhone

string | null

required

The customer's alternate telephone number.

data.fax

string | null

required

The customer's fax number.

data.email

string | null

required

The customer's email address.

data.ccEmail

string | null

required

An email address to carbon copy (CC) on communications with this customer.

data.contact

string | null

required

The name of the primary contact person for this customer.

data.alternateContact

string | null

required

The name of a alternate contact person for this customer.

data.customContactFields

object[]

required

Additional custom contact fields for this customer, such as phone numbers or email addresses.

data.additionalContacts

object[]

required

Additional alternate contacts for this customer.

data.additionalContacts.id

string

required

The unique identifier assigned by QuickBooks to this contact. This ID is unique across all contacts but not across different QuickBooks object types.

data.additionalContacts.objectType

string

required

The type of object. This value is always "qbd_contact".

Allowed value: "qbd_contact"

data.additionalContacts.createdAt

string

required

The date and time when this contact was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.additionalContacts.updatedAt

string

required

The date and time when this contact was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.additionalContacts.revisionNumber

string

required

The current revision number of this contact object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

data.additionalContacts.name

string | null

required

The contact's full name.

data.additionalContacts.salutation

string | null

required

The contact's formal salutation title that precedes their name, such as "Mr.", "Ms.", or "Dr.".

data.additionalContacts.firstName

string

required

The contact's first name.

data.additionalContacts.middleName

string | null

required

The contact's middle name.

data.additionalContacts.lastName

string | null

required

The contact's last name.

data.additionalContacts.jobTitle

string | null

required

The contact's job title.

data.additionalContacts.customContactFields

object[]

required

Additional custom contact fields for this contact, such as phone numbers or email addresses.

data.customerType

object | null

required

The customer's type, used for categorizing customers into meaningful segments, such as industry or region.

data.terms

object | null

required

The customer's payment terms, defining when payment is due and any applicable discounts.

data.salesRepresentative

object | null

required

The customer's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

data.balance

string | null

required

The current balance owed by this customer, excluding balances from any jobs (i.e., sub-customers), represented as a decimal string. Compare with totalBalance. A positive number indicates money owed by the customer.

data.totalBalance

string | null

required

The combined balance of this customer and all of this customer's jobs (i.e., sub-customers), represented as a decimal string. If there are no sub-customers, totalBalance and balance are equal. A positive number indicates money owed by the customer.

data.salesTaxCode

object | null

required

The default sales-tax code for transactions with this customer, determining whether the transactions are taxable or non-taxable. This can be overridden at the transaction or transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

data.salesTaxItem

object | null

required

The sales-tax item used to calculate the actual tax amount for this customer's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

data.salesTaxCountry

enum<string> | null

required

The country for which sales tax is collected for this customer.

Available options:

australia,

canada,

uk,

us

data.resaleNumber

string | null

required

The customer's resale number, used if the customer is purchasing items for resale. This number does not affect sales tax calculations or reports in QuickBooks.

data.accountNumber

string | null

required

The customer's account number, which appears in the QuickBooks chart of accounts, reports, and graphs. Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.

data.creditLimit

string | null

required

The customer's credit limit, represented as a decimal string. This is the maximum amount of money this customer can spend before being billed. If null, there is no credit limit.

data.preferredPaymentMethod

object | null

required

The customer's preferred payment method (e.g., cash, check, credit card).

data.creditCard

object | null

required

The customer's credit card information, including card type, number, and expiration date, used for processing credit card payments.

data.jobStatus

enum<string> | null

required

The status of this customer's job, if this object is a job (i.e., sub-customer).

Available options:

awarded,

closed,

in_progress,

none,

not_awarded,

pending

data.jobStartDate

string | null

required

The date when work on this customer's job began, if applicable, in ISO 8601 format (YYYY-MM-DD).

data.jobProjectedEndDate

string | null

required

The projected completion date for this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

data.jobEndDate

string | null

required

The actual completion date of this customer's job, if applicable, in ISO 8601 format (YYYY-MM-DD).

data.jobDescription

string | null

required

A brief description of this customer's job, if this object is a job (i.e., sub-customer).

data.jobType

object | null

required

The type or category of this customer's job, if this object is a job (i.e., sub-customer). Useful for classifying into meaningful segments (e.g., repair, installation, consulting).

data.note

string | null

required

Additional notes or comments about this customer.

data.additionalNotes

object[]

required

Additional notes about this customer.

data.preferredDeliveryMethod

enum<string> | null

required

The preferred method for delivering invoices and other documents to this customer.

Available options:

email,

mail,

none

data.priceLevel

object | null

required

The customer's custom price level that QuickBooks automatically applies to calculate item rates in new transactions (e.g., invoices, sales receipts, sales orders, and credit memos) for this customer. While applied automatically, this can be overridden when creating individual transactions. Note that transactions will not show the price level itself, only the final rate calculated from it.

data.externalId

string | null

required

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

data.taxRegistrationNumber

string | null

required

The customer's tax registration number, for use in Canada or the UK.

data.currency

object | null

required

The customer's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

data.customFields

object[]

required

The custom fields for the customer object, added as user-defined data extensions, not included in the standard QuickBooks object.

nextCursor

string | null

required

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.

remainingCount

number | null

required

The number of objects remaining to be fetched.

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

Retrieve a customer The Date-Driven Term object