List all classes - Conductor Docs

QuickBooks Desktop API

Core Resources

Auth Sessions
End Users

Utilities

GET
Health check

Transactions

All Transactions
Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Inventory Adjustments
Invoices
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

General

Accounts
Classes
Customers / Jobs
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Items

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

GET

quickbooks-desktop

classes

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 _class = await client.qbd.classes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(_class.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/classes",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_class",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Marketing",
      "fullName": "Department:Marketing",
      "isActive": true,
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Department"
      },
      "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"

Query Parameters

ids

string[]

Filter for specific classes 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.

Example:

["80000001-1234567890"]

fullNames

string[]

Filter for specific classes by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for a class, formed by by combining the names of its parent objects with its own name, separated by colons. For example, if a class is under "Department" and has the name "Marketing", its fullName would be "Department:Marketing".

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.

Example:

["Department:Marketing"]

limit

integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for classes. This parameter will limit the response size, but you cannot fetch subsequent results using a cursor. For pagination, use the name-range parameters instead (e.g., nameFrom=A&nameTo=B).

When this parameter is omitted, the endpoint returns all classes without limit, unlike paginated endpoints which default to 150 records. This is acceptable because classes typically have low record counts.

Required range: x >= 1

Example:

10

status

enum<string>

default:active

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

Available options:

active,

all,

inactive

Example:

"active"

updatedAfter

string

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

Example:

"2021-01-01T12:34:56.000Z"

updatedBefore

string

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

Example:

"2021-02-01T12:34:56.000Z"

nameContains

string

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

Example:

"ABC"

nameStartsWith

string

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

Example:

"ABC"

nameEndsWith

string

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

Example:

"ABC"

nameFrom

string

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

Example:

"A"

nameTo

string

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

Example:

"Z"

Response

200 - application/json

Returns a list of classes.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/classes"

data

object[]

required

The array of classes.

data.id

string

required

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

Example:

"80000001-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_class"

Example:

"qbd_class"

data.createdAt

string

required

The date and time when this class 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.

Example:

"2021-10-01T17:34:56.000Z"

data.updatedAt

string

required

The date and time when this class 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.

Example:

"2021-10-01T20:45:30.000Z"

data.revisionNumber

string

required

The current QuickBooks-assigned revision number of this class 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"

data.name

string

required

The case-insensitive name of this class. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName does. For example, two classes could both have the name "Marketing", but they could have unique fullName values, such as "Department:Marketing" and "Internal:Marketing".

Example:

"Marketing"

data.fullName

string

required

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

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

Example:

"Department:Marketing"

data.isActive

boolean

required

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

Example:

true

data.parent

object | null

required

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

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Department"
}

data.sublevel

number

required

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

Example:

1

Retrieve a class The Customer 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 _class = await client.qbd.classes.list({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(_class.data);
}

main();

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/classes",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_class",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "name": "Marketing",
      "fullName": "Department:Marketing",
      "isActive": true,
      "parent": {
        "id": "80000001-1234567890",
        "fullName": "Department"
      },
      "sublevel": 1
    }
  ]
}