--- title: "List all inventory sites" method: GET path: "/quickbooks-desktop/inventory-sites" --- # List all inventory sites `GET /quickbooks-desktop/inventory-sites` Returns a list of inventory sites. **NOTE:** QuickBooks Desktop does not support pagination for inventory sites; hence, there is no `cursor` parameter. Users typically have few inventory sites. ## Query parameters - `ids` string[] — Filter for specific inventory sites 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. - `names` string[] — Filter for specific inventory sites by their name(s), case-insensitive. Like `id`, `name` is a unique identifier for an inventory site. **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. - `status` 'active' | 'all' | 'inactive' — Filter for inventory sites that are active, inactive, or both. - `updatedAfter` string — Filter for inventory sites updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `updatedBefore` string — Filter for inventory sites updated on or before this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `nameContains` string — Filter for inventory sites whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`. - `nameStartsWith` string — Filter for inventory sites whose `name` starts with this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameEndsWith`. - `nameEndsWith` string — Filter for inventory sites whose `name` ends with this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameContains` or `nameStartsWith`. - `nameFrom` string — Filter for inventory sites whose `name` is alphabetically greater than or equal to this value. - `nameTo` string — Filter for inventory sites whose `name` is alphabetically less than or equal to this value. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns a list of inventory sites. - object - `objectType` 'list', required — The type of object. This value is always `"list"`. - `url` string, required — The endpoint URL where this list can be accessed. - `data` QbdInventorySite[], required — The array of inventory sites. - `id` string, required — The unique identifier assigned by QuickBooks to this inventory site. This ID is unique across all inventory sites but not across different QuickBooks object types. - `objectType` 'qbd_inventory_site', required — The type of object. This value is always `"qbd_inventory_site"`. - `createdAt` string, required — The date and time when this inventory site 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. - `updatedAt` string, required — The date and time when this inventory site 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. - `revisionNumber` string, required — The current QuickBooks-assigned revision number of this inventory site 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. - `name` string, required — The case-insensitive unique name of this inventory site, unique across all inventory sites. **NOTE**: Inventory sites do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents. - `isActive` boolean, required — Indicates whether this inventory site is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`. - `parent` object, nullable, required — The parent inventory site one level above this one in the hierarchy. - `id` string, nullable, required — The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. - `fullName` string, nullable, required — The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. - `isDefault` boolean, nullable, required — Indicates whether this inventory site is the default site used when no specific site is provided during the creation of other objects. - `description` string, nullable, required — A description of this inventory site. - `contact` string, nullable, required — The name of the primary contact person for this inventory site. - `phone` string, nullable, required — The inventory site's primary telephone number. - `fax` string, nullable, required — The inventory site's fax number. - `email` string, nullable, required — The inventory site's email address. - `address` QbdSiteAddress, required - `line1` string, nullable, required — The first line of the site address (e.g., street, PO Box, or company name). - `line2` string, nullable, required — The second line of the site address, if needed (e.g., apartment, suite, unit, or building). - `line3` string, nullable, required — The third line of the site address, if needed. - `line4` string, nullable, required — The fourth line of the site address, if needed. - `line5` string, nullable, required — The fifth line of the site address, if needed. - `city` string, nullable, required — The city, district, suburb, town, or village name of the site address. - `state` string, nullable, required — The state, county, province, or region name of the site address. - `postalCode` string, nullable, required — The postal code or ZIP code of the site address. - `country` string, nullable, required — The country name of the site address. --- [API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)