GET
/
quickbooks-desktop
/
unit-of-measure-sets
JavaScript
import Conductor from 'conductor-node';

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

const unitOfMeasureSets = await conductor.qbd.unitOfMeasureSets.list({
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(unitOfMeasureSets.data);
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/unit-of-measure-sets",
  "data": [
    {
      "id": "80000001-1234567890",
      "objectType": "qbd_unit_of_measure_set",
      "createdAt": "2021-10-01T12:34:56-05:00",
      "updatedAt": "2021-10-01T15:45:30-05:00",
      "revisionNumber": "1721172183",
      "name": "Weight Units",
      "isActive": true,
      "unitOfMeasureType": "count",
      "baseUnit": {
        "name": "Each",
        "abbreviation": "ea"
      },
      "relatedUnits": [
        {
          "name": "Case",
          "abbreviation": "ea",
          "conversionRatio": "10"
        }
      ],
      "defaultUnits": [
        {
          "unitUsedFor": "purchase",
          "unit": "Each"
        }
      ]
    }
  ]
}

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 unit-of-measure sets 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"]
​
names
string[]

Filter for specific unit-of-measure sets by their name(s), case-insensitive. Like id, name is a unique identifier for an unit-of-measure set.

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:
["Weight Units"]
​
limit
integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for unit-of-measure sets. 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 unit-of-measure sets without limit, unlike paginated endpoints which default to 150 records. This is acceptable because unit-of-measure sets typically have low record counts.

Required range: x >= 1
Example:

10

​
status
enum<string>
default:active

Filter for unit-of-measure sets that are active, inactive, or both.

Available options:
active,
all,
inactive
Example:

"active"

​
updatedAfter
string

Filter for unit-of-measure sets 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"

​
updatedBefore
string

Filter for unit-of-measure sets 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"

​
nameContains
string

Filter for unit-of-measure sets 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 unit-of-measure sets 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 unit-of-measure sets 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 unit-of-measure sets whose name is alphabetically greater than or equal to this value.

Example:

"A"

​
nameTo
string

Filter for unit-of-measure sets whose name is alphabetically less than or equal to this value.

Example:

"Z"

Response

200 - application/json

Returns a list of unit-of-measure sets.

The response is of type object.