v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Retrieve a class

Retrieves a class by ID.

IMPORTANT: If you need to fetch multiple specific classes by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/classes/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the class to retrieve.

Example:80000001-1234567890

The QuickBooks-assigned unique identifier of the class to retrieve.

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Response

Returns the specified class.

idstring required

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

objectType'qbd_class' required

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

createdAtstring required

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

updatedAtstring required

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

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

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

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

isActiveboolean required

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

sublevelnumber 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 response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_class",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Marketing",
  "fullName": "Department:Marketing",
  "isActive": true,
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Department"
  },
  "sublevel": 1
}