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

# Returned Assets

> Retrieve the items that have been brought back, most recent return first.



## OpenAPI

````yaml GET /api/checkout/returned-assets
openapi: 3.0.1
info:
  title: EZYiD API
  version: '1.0'
servers:
  - url: https://api-external.ezyid.io
security: []
tags:
  - name: EZYiD.External.API
paths:
  /api/checkout/returned-assets:
    get:
      tags:
        - EZYiD.External.API
      summary: List returned items
      description: >-
        Returns the items that have been brought back, most recent return first.
        The date filters apply to the checkout date, matching the kiosk
        dashboard.
      operationId: EZYiDExternalAPICheckoutGetReturnedAssets
      parameters:
        - name: apiKey
          in: query
          required: true
          schema:
            type: string
        - name: dateFrom
          in: query
          description: Inclusive UTC lower bound on the checkout date.
          schema:
            type: string
            format: date-time
        - name: dateTo
          in: query
          description: Inclusive UTC upper bound on the checkout date.
          schema:
            type: string
            format: date-time
        - name: isConsumable
          in: query
          description: >-
            Omit for both, `true` for consumables only, `false` for tracked
            assets only.
          schema:
            type: boolean
        - name: categoryIds
          in: query
          description: Comma-separated category ids.
          schema:
            type: string
        - name: siteIds
          in: query
          description: Comma-separated site ids.
          schema:
            type: string
        - name: projectIds
          in: query
          description: Comma-separated project ids.
          schema:
            type: string
        - name: companyIds
          in: query
          description: 'Comma-separated contact ids: the company the holder belongs to.'
          schema:
            type: string
        - name: personnelIds
          in: query
          description: >-
            Comma-separated APK ids of the personnel the items were checked out
            to.
          schema:
            type: string
        - name: assetStatus
          in: query
          description: Asset status for assets, inventory status for consumables.
          schema:
            type: integer
            format: int32
        - name: limit
          in: query
          description: Rows to return.
          schema:
            type: integer
            format: int32
            default: 100
            minimum: 1
            maximum: 1000
      responses:
        '200':
          description: OK. An empty array when nothing matches.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CheckoutAssetItem'
        '400':
          description: The API key is missing, or an id list or limit is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: The API key is revoked or expired.
        '404':
          description: The API key does not exist.
components:
  schemas:
    CheckoutAssetItem:
      type: object
      description: 'One checked-out line: an asset, or a quantity of a consumable.'
      properties:
        id:
          type: integer
          format: int32
          description: Checkout line id, unique across both assets and consumables.
        apkId:
          type: integer
          format: int32
          nullable: true
        assetName:
          type: string
          nullable: true
        serialNumber:
          type: string
          nullable: true
          description: Serial number for an asset, part number for a consumable.
        ezyid:
          type: string
          nullable: true
          description: Assets only.
        customId:
          type: string
          nullable: true
          description: Assets only.
        categoryId:
          type: integer
          format: int32
          nullable: true
        categoryName:
          type: string
          nullable: true
        siteId:
          type: integer
          format: int32
          nullable: true
        siteName:
          type: string
          nullable: true
        projectId:
          type: integer
          format: int32
          nullable: true
        projectName:
          type: string
          nullable: true
        checkoutDate:
          type: string
          format: date-time
          nullable: true
          description: UTC.
        expectedReturnDate:
          type: string
          format: date-time
          nullable: true
          description: UTC. The date isOverdue is measured against.
        returnedDate:
          type: string
          format: date-time
          nullable: true
          description: UTC. Only set once the line has been returned.
        isOverdue:
          type: boolean
          description: >-
            Past its expected return date. Also true when no return date was
            set.
        contractorName:
          type: string
          nullable: true
          description: Who holds the item.
        contractorApkId:
          type: integer
          format: int32
          nullable: true
        contractorMobileNumber:
          type: string
          nullable: true
        contractorEmail:
          type: string
          nullable: true
        contractorCompany:
          type: string
          nullable: true
        contactId:
          type: integer
          format: int32
          nullable: true
        assetStatus:
          type: integer
          format: int32
          nullable: true
          description: Asset status for an asset, inventory status for a consumable.
        isConsumable:
          type: boolean
        quantity:
          type: number
          format: double
          nullable: true
          description: >-
            Quantity taken. Consumables only; null for assets, which are always
            one each.
        locationName:
          type: string
          nullable: true
          description: Shelf location. Assets only.
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: >-
            What was wrong with the request, naming the field or operator at
            fault.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.