> ## 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.

# Retrieve warehouse transfer transactions with pagination.



## OpenAPI

````yaml api-reference/openapi.json get /api/warehouse-transfers
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/warehouse-transfers:
    get:
      tags:
        - Warehouse Transfers
      summary: Retrieve warehouse transfer transactions with pagination.
      operationId: WarehouseTransfersController_getWarehousesTransfers
      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
      responses:
        '200':
          description: >-
            The warehouse transfer transactions have been retrieved
            successfully.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponseDto'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/WarehouseTransferResponseDto'
components:
  schemas:
    PaginatedResponseDto:
      type: object
      properties:
        pagination:
          description: Pagination metadata
          allOf:
            - $ref: '#/components/schemas/Pagination'
      required:
        - pagination
    WarehouseTransferResponseDto:
      type: object
      properties:
        id:
          type: number
          description: The ID of the warehouse transfer
          example: 1
        date:
          format: date-time
          type: string
          description: The date of the warehouse transfer
          example: '2024-03-20'
        formattedDate:
          type: string
          description: The formatted date of the warehouse transfer
          example: Mar 20, 2024
        transactionNumber:
          type: string
          description: The transaction number of the warehouse transfer
          example: WT-2024-001
        fromWarehouseId:
          type: number
          description: The ID of the source warehouse
          example: 1
        toWarehouseId:
          type: number
          description: The ID of the destination warehouse
          example: 2
        transferInitiatedAt:
          format: date-time
          type: string
          description: The date when the transfer was initiated
          example: '2024-03-20T10:00:00Z'
        transferDeliveredAt:
          format: date-time
          type: string
          description: The date when the transfer was delivered
          example: '2024-03-21T15:00:00Z'
        isInitiated:
          type: boolean
          description: Whether the transfer has been initiated
          example: true
        isTransferred:
          type: boolean
          description: Whether the transfer has been completed
          example: true
        fromWarehouse:
          type: object
          description: The source warehouse details
        toWarehouse:
          type: object
          description: The destination warehouse details
        entries:
          description: The entries of the warehouse transfer
          type: array
          items:
            $ref: '#/components/schemas/WarehouseTransferEntryResponseDto'
        createdAt:
          format: date-time
          type: string
          description: The creation date of the warehouse transfer
          example: '2024-03-20T09:00:00Z'
        updatedAt:
          format: date-time
          type: string
          description: The last update date of the warehouse transfer
          example: '2024-03-21T15:00:00Z'
      required:
        - id
        - date
        - formattedDate
        - transactionNumber
        - fromWarehouseId
        - toWarehouseId
        - transferInitiatedAt
        - transferDeliveredAt
        - isInitiated
        - isTransferred
        - fromWarehouse
        - toWarehouse
        - entries
        - 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
    WarehouseTransferEntryResponseDto:
      type: object
      properties:
        id:
          type: number
          description: The ID of the warehouse transfer entry
          example: 1
        itemId:
          type: number
          description: The ID of the item being transferred
          example: 1
        quantity:
          type: number
          description: The quantity of items being transferred
          example: 100
        cost:
          type: number
          description: The cost per unit of the item
          example: 10.5
        total:
          type: number
          description: The total cost of the transfer entry
          example: 1050
        formattedQuantity:
          type: string
          description: The formatted quantity of items being transferred
          example: '100.00'
        formattedCost:
          type: string
          description: The formatted cost per unit of the item
          example: $10.50
        formattedTotal:
          type: string
          description: The formatted total cost of the transfer entry
          example: $1,050.00
        item:
          type: object
          description: The item details
      required:
        - id
        - itemId
        - quantity
        - cost
        - total
        - formattedQuantity
        - formattedCost
        - formattedTotal
        - item

````