> ## Documentation Index > Fetch the complete documentation index at: https://docs.conductor.is/llms.txt > Use this file to discover all available pages before exploring further. # List all 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. ## OpenAPI ````yaml GET /quickbooks-desktop/inventory-sites openapi: 3.1.0 info: title: Conductor API version: 0.0.1 servers: - url: https://api.conductor.is/v1 security: - BearerAuth: [] paths: /quickbooks-desktop/inventory-sites: get: summary: List all inventory sites description: >- 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. parameters: - in: query name: ids description: >- 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. schema: type: array items: type: string description: >- 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. example: - 80000001-1234567890 - in: query name: names description: >- 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. schema: type: array items: type: string description: >- 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. example: - Stockroom - in: query name: status description: Filter for inventory sites that are active, inactive, or both. schema: type: string enum: - active - all - inactive default: active description: Filter for inventory sites that are active, inactive, or both. example: active - in: query name: updatedAfter description: >- 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. schema: type: string description: >- 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. example: '2025-01-01T12:34:56.000Z' - in: query name: updatedBefore description: >- 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. schema: type: string description: >- 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. example: '2025-02-01T12:34:56.000Z' - in: query name: nameContains description: >- Filter for inventory sites whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`. schema: type: string description: >- Filter for inventory sites whose `name` contains this substring, case-insensitive. **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or `nameEndsWith`. example: ABC - in: query name: nameStartsWith description: >- 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`. schema: type: string description: >- 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`. example: ABC - in: query name: nameEndsWith description: >- 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`. schema: type: string description: >- 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`. example: ABC - in: query name: nameFrom description: >- Filter for inventory sites whose `name` is alphabetically greater than or equal to this value. schema: type: string description: >- Filter for inventory sites whose `name` is alphabetically greater than or equal to this value. example: A - in: query name: nameTo description: >- Filter for inventory sites whose `name` is alphabetically less than or equal to this value. schema: type: string description: >- Filter for inventory sites whose `name` is alphabetically less than or equal to this value. example: Z - in: header name: Conductor-End-User-Id description: The ID of the End-User to receive this request. schema: type: string description: The ID of the End-User to receive this request. example: end_usr_1234567abcdefg x-stainless-naming: typescript: method_argument: conductorEndUserId mcp: method_argument: conductorEndUserId required: true responses: '200': description: Returns a list of inventory sites. headers: Conductor-Request-Id: schema: type: string description: The unique identifier for this API request. example: req_1234567abcdefg required: true content: application/json: schema: type: object properties: objectType: type: string const: list description: The type of object. This value is always `"list"`. example: list url: type: string description: The endpoint URL where this list can be accessed. example: /v1/quickbooks-desktop/inventory-sites data: type: array items: $ref: '#/components/schemas/qbd_inventory_site' description: The array of inventory sites. required: - objectType - url - data additionalProperties: false security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: |- import Conductor from 'conductor-node'; const conductor = new Conductor({ apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted }); const inventorySites = await conductor.qbd.inventorySites.list({ conductorEndUserId: 'end_usr_1234567abcdefg', }); console.log(inventorySites.data); - lang: Python source: |- import os from conductor import Conductor conductor = Conductor( api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted ) inventory_sites = conductor.qbd.inventory_sites.list( conductor_end_user_id="end_usr_1234567abcdefg", ) print(inventory_sites.data) components: schemas: qbd_inventory_site: type: object properties: id: type: string description: >- 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. example: 80000001-1234567890 objectType: type: string const: qbd_inventory_site description: The type of object. This value is always `"qbd_inventory_site"`. example: qbd_inventory_site createdAt: type: string description: >- 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. example: '2025-01-01T12:34:56.000Z' updatedAt: type: string description: >- 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. example: '2025-02-01T12:34:56.000Z' revisionNumber: type: string description: >- 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. example: '1721172183' name: type: string description: >- 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. example: Stockroom isActive: type: boolean description: >- Indicates whether this inventory site is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`. example: true parent: type: - object - 'null' properties: id: type: - string - 'null' description: >- 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. example: 80000001-1234567890 fullName: type: - string - 'null' description: >- 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. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: The parent inventory site one level above this one in the hierarchy. example: id: 80000001-1234567890 fullName: Romulus Warehouse:Stockroom isDefault: type: - boolean - 'null' description: >- Indicates whether this inventory site is the default site used when no specific site is provided during the creation of other objects. example: true description: type: - string - 'null' description: A description of this inventory site. example: Main Stockroom for Electronics contact: type: - string - 'null' description: The name of the primary contact person for this inventory site. example: Jane Smith phone: type: - string - 'null' description: The inventory site's primary telephone number. example: +1-555-123-4567 fax: type: - string - 'null' description: The inventory site's fax number. example: +1-555-555-1212 email: type: - string - 'null' description: The inventory site's email address. example: inventory-site@example.com address: oneOf: - $ref: '#/components/schemas/qbd_site_address' - type: 'null' description: The inventory site's address. required: - id - objectType - createdAt - updatedAt - revisionNumber - name - isActive - parent - isDefault - description - contact - phone - fax - email - address additionalProperties: false title: The Inventory Site object x-conductor-object-type: other summary: >- An inventory site is a location where inventory is stored. For example, a company might have a warehouse, a stockroom, and a showroom, each of which is an inventory site. NOTE: Inventory sites require QuickBooks Enterprise with an Advanced Inventory subscription. qbd_site_address: type: object properties: line1: type: - string - 'null' description: >- The first line of the site address (e.g., street, PO Box, or company name). example: Conductor Labs Inc. line2: type: - string - 'null' description: >- The second line of the site address, if needed (e.g., apartment, suite, unit, or building). example: 540 Market St. line3: type: - string - 'null' description: The third line of the site address, if needed. example: Suite 100 line4: type: - string - 'null' description: The fourth line of the site address, if needed. example: '' line5: type: - string - 'null' description: The fifth line of the site address, if needed. example: '' city: type: - string - 'null' description: >- The city, district, suburb, town, or village name of the site address. example: San Francisco state: type: - string - 'null' description: The state, county, province, or region name of the site address. example: CA postalCode: type: - string - 'null' description: The postal code or ZIP code of the site address. example: '94110' country: type: - string - 'null' description: The country name of the site address. example: United States required: - line1 - line2 - line3 - line4 - line5 - city - state - postalCode - country additionalProperties: false title: The Site Address object x-conductor-object-type: nested securitySchemes: BearerAuth: type: http scheme: bearer description: >- Your Conductor secret key using Bearer auth (e.g., `"Authorization: Bearer {{YOUR_SECRET_KEY}}"`). ```` Built with [Mintlify](https://mintlify.com).