> ## 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 item sites > Returns a list of item sites. Use the `cursor` parameter to paginate through the results. ## OpenAPI ````yaml GET /quickbooks-desktop/item-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/item-sites: get: summary: List all item sites description: >- Returns a list of item sites. Use the `cursor` parameter to paginate through the results. parameters: - in: query name: ids description: >- Filter for specific item 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 item 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: itemType description: Filter for item sites that match this item type. schema: type: string enum: - all_except_fixed_asset - assembly - discount - fixed_asset - inventory - inventory_and_assembly - non_inventory - other_charge - payment - sales - sales_tax - service description: Filter for item sites that match this item type. example: inventory - in: query name: itemIds description: Filter for item sites for these items. schema: type: array items: type: string description: Filter for item sites for these items. example: - 80000001-1234567890 - in: query name: siteIds description: >- Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store. schema: type: array items: type: string description: >- Filter for item sites at these sites. A site represents a physical location, such as a warehouse or store. example: - 80000001-1234567890 - in: query name: limit description: >- The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results. schema: type: integer minimum: 1 maximum: 150 default: 150 description: >- The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results. example: 150 - in: query name: cursor description: >- The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. schema: type: string description: >- The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. example: 12345678-abcd-abcd-example-1234567890ab - in: query name: status description: Filter for item sites that are active, inactive, or both. schema: type: string enum: - active - all - inactive default: active description: Filter for item sites that are active, inactive, or both. example: active - 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 item 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/item-sites data: type: array items: $ref: '#/components/schemas/qbd_item_site' description: The array of item sites. nextCursor: type: - string - 'null' description: >- The `nextCursor` is a pagination token returned in the response when you use the `limit` parameter in your request. To retrieve subsequent pages of results, include this token as the value of the `cursor` request parameter in your following API calls. **NOTE**: The `nextCursor` value remains constant throughout the pagination process for a specific list instance; continue to use the same `nextCursor` token in each request to fetch additional pages. example: 12345678-abcd-abcd-example-1234567890ab remainingCount: type: - number - 'null' description: The number of objects remaining to be fetched. example: 10 hasMore: type: boolean description: Indicates whether there are more objects to be fetched. required: - objectType - url - data - nextCursor - remainingCount - hasMore 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 }); // Automatically fetches more pages as needed. for await (const itemSite of conductor.qbd.itemSites.list({ conductorEndUserId: 'end_usr_1234567abcdefg', })) { console.log(itemSite.id); } - 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 ) page = conductor.qbd.item_sites.list( conductor_end_user_id="end_usr_1234567abcdefg", ) page = page.data[0] print(page.id) components: schemas: qbd_item_site: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this item site. This ID is unique across all item sites but not across different QuickBooks object types. example: 80000001-1234567890 objectType: type: string const: qbd_item_site description: The type of object. This value is always `"qbd_item_site"`. example: qbd_item_site createdAt: type: string description: >- The date and time when this item 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 item 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 item 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' inventoryAssemblyItem: 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 inventory assembly item associated with this item site. An inventory assembly item is assembled or manufactured from other inventory items, and the items and/or assemblies that make up the assembly are called components. example: id: 80000001-1234567890 fullName: Inventory Assembly Item inventoryItem: 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 inventory item associated with this item site. example: id: 80000001-1234567890 fullName: Inventory Item inventorySite: 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 site location where inventory for the item associated with this item site is stored. example: id: 80000001-1234567890 fullName: Main Warehouse inventorySiteLocation: 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 specific location (e.g., bin or shelf) within the inventory site where the item associated with this item site is stored. example: id: 80000001-1234567890 fullName: Aisle 3, Shelf B reorderLevel: type: - number - 'null' description: >- The inventory level at which QuickBooks prompts you to reorder this item site. example: 25 quantityOnHand: type: - number - 'null' description: The number of units of this item site currently in inventory. example: 150 quantityOnPurchaseOrders: type: - number - 'null' description: >- The number of units of this item site that are currently listed on outstanding purchase orders and have not yet been received. example: 40 quantityOnSalesOrders: type: - number - 'null' description: >- The number of units of this item site that are currently listed on outstanding sales orders and have not yet been fulfilled or delivered to customers. example: 30 quantityToBeBuiltByPendingBuildTransactions: type: - number - 'null' description: >- The number of units of this item site that are scheduled to be built on pending build transactions. example: 15 quantityRequiredByPendingBuildTransactions: type: - number - 'null' description: >- The number of units of this item site required by pending build transactions. example: 12 quantityOnPendingTransfers: type: - number - 'null' description: >- The number of units of this item site that are currently on pending inventory transfer transactions. example: 8 assemblyBuildPoint: type: - number - 'null' description: >- The inventory level of this item site at which a new build assembly should begin. When the combined `quantityOnHand` and `quantityOnPurchaseOrders` drops below this point, QuickBooks flags the need to build additional units. example: 20 required: - id - objectType - createdAt - updatedAt - revisionNumber - inventoryAssemblyItem - inventoryItem - inventorySite - inventorySiteLocation - reorderLevel - quantityOnHand - quantityOnPurchaseOrders - quantityOnSalesOrders - quantityToBeBuiltByPendingBuildTransactions - quantityRequiredByPendingBuildTransactions - quantityOnPendingTransfers - assemblyBuildPoint additionalProperties: false title: The Item Site object x-conductor-object-type: item summary: >- An item site represents a location where inventory items are stored. This is useful for tracking inventory at different locations, such as a warehouse or a store. 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).