> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieves the item list.



## OpenAPI

````yaml api-reference/openapi.json get /api/items
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/items:
    get:
      tags:
        - Items
      summary: Retrieves the item list.
      operationId: ItemsController_getItems
      parameters:
        - name: Authorization
          in: header
          description: >-
            Value must be 'Bearer <token>' where <token> is an API key prefixed
            with 'bc_' or a JWT token.
          required: true
          schema:
            type: string
            example: Bearer bc_1234567890abcdef
        - name: organization-id
          in: header
          description: >-
            Required if Authorization is a JWT token. The organization ID to
            operate within.
          required: true
          schema:
            type: string
        - name: inactiveMode
          required: false
          in: query
          description: Filter for inactive items
          schema:
            type: boolean
        - name: pageSize
          required: false
          in: query
          description: Number of items per page
          schema:
            type: number
        - name: page
          required: false
          in: query
          description: Page number for pagination
          schema:
            type: number
        - name: viewSlug
          required: false
          in: query
          description: View slug for filtering
          schema:
            type: string
        - name: searchKeyword
          required: false
          in: query
          description: Search keyword
          schema:
            type: string
        - name: stringifiedFilterRoles
          required: false
          in: query
          description: Stringified filter roles
          schema:
            type: string
        - name: sortOrder
          required: false
          in: query
          description: Sort order direction
          schema:
            enum:
              - DESC
              - ASC
            type: string
        - name: columnSortBy
          required: false
          in: query
          description: Column sort direction
          schema:
            type: string
        - name: filterRoles
          required: false
          in: query
          description: Array of filter roles
          schema:
            type: array
            items:
              type: string
        - name: customViewId
          required: false
          in: query
          description: Custom view ID for filtering
          schema:
            type: number
      responses:
        '200':
          description: The item list has been successfully retrieved.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponseDto'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/ItemResponseDto'
components:
  schemas:
    PaginatedResponseDto:
      type: object
      properties:
        pagination:
          description: Pagination metadata
          allOf:
            - $ref: '#/components/schemas/Pagination'
      required:
        - pagination
    ItemResponseDto:
      type: object
      properties:
        id:
          type: number
          description: The unique identifier of the item
          example: 1
        name:
          type: string
          description: The name of the item
          example: Ergonomic Office Chair Model X-2000
        type:
          type: string
          description: The type of the item
          enum:
            - service
            - non-inventory
            - inventory
          example: inventory
        typeFormatted:
          type: string
          description: The formatted type of the item
          example: Inventory Item
        code:
          type: string
          description: The item code/SKU
          example: CHAIR-X2000
        sellable:
          type: boolean
          description: Whether the item can be sold
          example: true
        purchasable:
          type: boolean
          description: Whether the item can be purchased
          example: true
        sellPrice:
          type: number
          description: The selling price of the item
          example: 399.99
        sellPriceFormatted:
          type: string
          description: The formatted selling price of the item
          example: $399.99
        costPrice:
          type: number
          description: The cost price of the item
          example: 299.99
        costPriceFormatted:
          type: string
          description: The formatted cost price of the item
          example: $299.99
        currencyCode:
          type: string
          description: The currency code of the item
          example: USD
        costAccountId:
          type: number
          description: The ID of the cost account
          example: 1001
        costAccount:
          type: object
          description: The cost account details
        inventoryAccountId:
          type: number
          description: The ID of the inventory account
          example: 3001
        inventoryAccount:
          type: object
          description: The inventory account details
        sellAccountId:
          type: number
          description: The ID of the sell account
          example: 2001
        sellAccount:
          type: object
          description: The sell account details
        categoryId:
          type: number
          description: The ID of the item category
          example: 5
        category:
          type: object
          description: The category details
        sellDescription:
          type: string
          description: The description shown on sales documents
          example: >-
            Premium ergonomic office chair with adjustable height and lumbar
            support
        purchaseDescription:
          type: string
          description: The description shown on purchase documents
          example: Ergonomic office chair - Model X-2000 with standard features
        quantityOnHand:
          type: number
          description: The quantity of the item in stock (for inventory items)
          example: 50
        note:
          type: string
          description: Additional notes about the item
          example: Available in black, gray, and navy colors. 5-year warranty included.
        active:
          type: boolean
          description: Whether the item is active
          example: true
        sellTaxRateId:
          type: number
          description: The ID of the tax rate applied to sales
          example: 1
        sellTaxRate:
          type: object
          description: The tax rate details for sales
        purchaseTaxRateId:
          type: number
          description: The ID of the tax rate applied to purchases
          example: 1
        purchaseTaxRate:
          type: object
          description: The tax rate details for purchases
        itemWarehouses:
          type: array
          description: The warehouse quantities for the item
        createdAt:
          format: date-time
          type: string
          description: The date when the item was created
          example: '2024-03-20T10:00:00Z'
        updatedAt:
          format: date-time
          type: string
          description: The date when the item was last updated
          example: '2024-03-20T10:00:00Z'
      required:
        - id
        - name
        - type
        - typeFormatted
        - sellable
        - purchasable
        - currencyCode
        - active
        - createdAt
        - updatedAt
    Pagination:
      type: object
      properties:
        total:
          type: number
          description: Total number of items across all pages
          example: 100
        page:
          type: number
          description: Current page number (1-based)
          example: 1
          minimum: 1
        pageSize:
          type: number
          description: Number of items per page
          example: 10
          minimum: 1
      required:
        - total
        - page
        - pageSize

````