List all classes
Returns a list of classes.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Query Parameters
Filter for specific classes by their QuickBooks-assigned unique identifier(s).
IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters.
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".
Unlike name
, fullName
is guaranteed to be unique across all class 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. NOTE: QuickBooks Desktop does not support cursor-based pagination for classes. Hence, this parameter will limit the response size, but you will not be able to fetch the next set of results. To paginate through the results for this endpoint, try fetching batches via the name-range (e.g., nameFrom=A&nameTo=B
) query parameters.
Filter for classes that are active, inactive, or both.
active
, all
, inactive
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.
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.
Filter for classes whose name
contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith
or nameEndsWith
.
Filter for classes whose name
starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains
or nameEndsWith
.
Filter for classes whose name
ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains
or nameStartsWith
.
Filter for classes whose name
is alphabetically greater than or equal to this value.
Filter for classes whose name
is alphabetically less than or equal to this value.
Response
The type of object. This value is always "list"
.
"list"
The endpoint URL where this list can be accessed.
The array of classes.