Skip to main content
GET
/
quickbooks-desktop
/
customer-types
/
{id}
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

const customerType = await conductor.qbd.customerTypes.retrieve('80000001-1234567890', {
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(customerType.id);
{
  "id": "80000001-1234567890",
  "objectType": "qbd_customer_type",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Healthcare",
  "fullName": "Industry:Healthcare",
  "isActive": true,
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Industry"
  },
  "sublevel": 1
}

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"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the customer type to retrieve.

Example:

"80000001-1234567890"

Response

200 - application/json

Returns the specified customer type.

​
id
string
required

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

Example:

"80000001-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_customer_type"
Example:

"qbd_customer_type"

​
createdAt
string
required

The date and time when this customer type was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56+00:00"

​
updatedAt
string
required

The date and time when this customer type was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56+00:00"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this customer type 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.

Example:

"1721172183"

​
name
string
required

The case-insensitive name of this customer type. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two customer types could both have the name "Healthcare", but they could have unique fullName values, such as "Industry:Healthcare" and "Region:Healthcare".

Example:

"Healthcare"

​
fullName
string
required

The case-insensitive fully-qualified unique name of this customer type, formed by combining the names of its hierarchical parent objects with its own name, separated by colons. For example, if a customer type is under "Industry" and has the name "Healthcare", its fullName would be "Industry:Healthcare".

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

Example:

"Industry:Healthcare"

​
isActive
boolean
required

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

Example:

true

​
parent
object | null
required

The parent customer type one level above this one in the hierarchy. For example, if this customer type has a fullName of "Industry:Healthcare", its parent has a fullName of "Industry". If this customer type is at the top level, this field will be null.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Industry"
}
​
sublevel
number
required

The depth level of this customer type in the hierarchy. A top-level customer type has a sublevel of 0; each subsequent sublevel increases this number by 1. For example, a customer type with a fullName of "Industry:Healthcare" would have a sublevel of 1.

Example:

1

⌘I