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

# Available Assets

> Retrieve the assets on the shelf and ready to be checked out.



## OpenAPI

````yaml GET /api/checkout/available-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/available-assets:
    get:
      tags:
        - EZYiD.External.API
      summary: List available assets
      description: >-
        Returns the assets on the shelf and ready to be checked out, meaning
        asset status 8.
      operationId: EZYiDExternalAPICheckoutGetAvailableAssets
      parameters:
        - name: apiKey
          in: query
          required: true
          schema:
            type: string
        - name: categoryIds
          in: query
          description: Comma-separated category ids, as in `3,4`.
          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: 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 is available.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AvailableAssetItem'
        '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:
    AvailableAssetItem:
      type: object
      description: One asset on the shelf and ready to be checked out.
      properties:
        id:
          type: integer
          format: int32
        apkId:
          type: integer
          format: int32
          nullable: true
        assetName:
          type: string
          nullable: true
        serialNumber:
          type: string
          nullable: true
        ezyid:
          type: string
          nullable: true
        customId:
          type: string
          nullable: true
        categoryId:
          type: integer
          format: int32
          nullable: true
        categoryName:
          type: string
          nullable: true
        partNumber:
          type: string
          nullable: true
        manufacturerName:
          type: string
          nullable: true
        siteId:
          type: integer
          format: int32
          nullable: true
        siteName:
          type: string
          nullable: true
        projectName:
          type: string
          nullable: true
        binLocationId:
          type: integer
          format: int32
          nullable: true
        assetStatus:
          type: integer
          format: int32
          nullable: true
          description: Always 8 (Available) for this endpoint.
    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.