List all customers

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

Filter for specific customers by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

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

Unlike name, fullName is guaranteed to be unique across all customer objects. Also, unlike id, fullName can be arbitrarily changed by the QuickBooks user when modifying its underlying name field.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.

The maximum number of objects to return. Ranging from 1 to 150, defaults to 150. Use this parameter in conjunction with the cursor parameter to paginate through results. The response will include a nextCursor field, which can be used as the cursor parameter value in subsequent requests to fetch the next set of results.

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.

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

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.

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.

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

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

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

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

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

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

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.

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.

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.

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.

Filter for customers in this currency or currencies.

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

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

The endpoint URL where this list can be accessed.

The array 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. 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.

The number of objects remaining to be fetched.

Indicates whether there are more objects to be fetched.