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

# List available labels

> Finds labels that can be used for new assets. The response is an object with two separate properties: `Summary` (counts) and `Labels` (rows).

`Labels` contains only available labels: states `0` (Healthy) and `8` (Near expiration). `Summary` also counts assigned labels (state `2`), and `Total` is the sum of the three counts. Assigned labels are not returned as rows, so do not expect the number of rows to equal `Total`. Label states are a separate set of values from asset statuses.

Returns the available labels your integration can access. Each row includes the label's `AccountID`; use a label whose `AccountID` matches the asset's `AccountID`.

Results are returned in one response. Retrieve the list when you need to choose a label. The response example shows a subset of row fields.



## OpenAPI

````yaml /openapi/openapi.json get /Labels/GetLabels
openapi: 3.1.0
info:
  title: Aiyoti Integration API Basic
  description: Create, retrieve, update, and manage the tracking lifecycle of assets.
  version: 0.0.1
servers:
  - url: https://api.aiyoticloud.com
security: []
tags:
  - name: Users
    description: Log in and refresh credentials.
  - name: Carriers
    description: Look up the carriers available to an account.
  - name: Labels
    description: Look up the labels available for new assets.
  - name: Assets / Shipments
    description: Create, list, retrieve, edit, annotate, and delete assets.
paths:
  /Labels/GetLabels:
    get:
      tags:
        - Labels
      summary: List available labels
      description: >-
        Finds labels that can be used for new assets. The response is an object
        with two separate properties: `Summary` (counts) and `Labels` (rows).


        `Labels` contains only available labels: states `0` (Healthy) and `8`
        (Near expiration). `Summary` also counts assigned labels (state `2`),
        and `Total` is the sum of the three counts. Assigned labels are not
        returned as rows, so do not expect the number of rows to equal `Total`.
        Label states are a separate set of values from asset statuses.


        Returns the available labels your integration can access. Each row
        includes the label's `AccountID`; use a label whose `AccountID` matches
        the asset's `AccountID`.


        Results are returned in one response. Retrieve the list when you need to
        choose a label. The response example shows a subset of row fields.
      operationId: get_labels_Labels_GetLabels_get
      parameters:
        - name: AccountID
          in: query
          description: >-
            Account identifier for the label lookup. Defaults to your login
            account.
          schema:
            type: string
          example: '00000000000000000000000000000002'
      responses:
        '200':
          description: >-
            Successful response. An object with `Summary` and `Labels`. Example
            rows show a subset of fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelsResponse'
              example:
                Summary:
                  Total: 3
                  Healthy: 1
                  NearExpiration: 1
                  Assigned: 1
                Labels:
                  - LabelID: 100002
                    StatusNo: 0
                    Status: Available
                    SubStatus: Healthy
                    SKU: EXAMPLE-SKU
                    AccountName: Example Account
                    AccountID: '00000000000000000000000000000002'
                  - LabelID: 100003
                    StatusNo: 8
                    Status: Available
                    SubStatus: Near Expiration
                    SKU: EXAMPLE-SKU
                    AccountName: Example Account
                    AccountID: '00000000000000000000000000000002'
        '400':
          description: >-
            Request rejected, for example for an invalid or expired AccessKey or
            an unknown AccountID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                Code: 400
                Message: Account not found.
        '422':
          description: Request validation failed. Check required fields and value types.
      security:
        - accessKey: []
components:
  schemas:
    LabelsResponse:
      type: object
      properties:
        Summary:
          $ref: '#/components/schemas/LabelSummary'
        Labels:
          type: array
          description: >-
            Available labels (states `0` and `8`). Assigned labels are not
            included.
          items:
            $ref: '#/components/schemas/AvailableLabel'
      description: >-
        Label counts and available labels. The two properties are computed
        separately.
    ApiError:
      type: object
      properties:
        Code:
          type: integer
          description: Application error code.
        Message:
          type: string
          description: Error message.
      description: Request error.
    LabelSummary:
      type: object
      properties:
        Total:
          type: integer
          description: >-
            Healthy plus NearExpiration plus Assigned. Not the number of rows in
            `Labels`.
        Healthy:
          type: integer
          description: Labels in state `0`.
        NearExpiration:
          type: integer
          description: Labels in state `8`.
        Assigned:
          type: integer
          description: >-
            Labels in state `2`. They are counted here but are not returned in
            `Labels`.
      description: Counts of available and assigned labels.
    AvailableLabel:
      type: object
      properties:
        LabelID:
          description: Label identifier. Use it as `LabelID` when creating an asset.
        NFC_ID:
          description: NFC identifier of the label.
        ManufactureDate:
          description: Manufacture date and time.
        ActivationDate:
          description: Activation date and time.
        StatusNo:
          description: >-
            Label state. This operation returns `0` (Healthy) and `8` (Near
            expiration). Label states are separate from asset status values.
        Status:
          type: string
          description: Label state group. `Available` for the rows this operation returns.
        SubStatus:
          type: string
          description: '`Healthy` for state `0`, `Near Expiration` for state `8`.'
        SKU:
          description: SKU name of the label.
        BatteryLife:
          description: Battery life of the SKU.
        AccountName:
          description: Name of the account that holds the label.
        AccountID:
          description: Unique identifier of the account that holds the label.
        ExpirationDate:
          description: >-
            Expiration date and time, calculated from the manufacture date and
            `ShelfLife`.
        DaysToExpire:
          description: Days until expiration.
        ShelfLife:
          description: Shelf life of the SKU in days.
        LotNo:
          description: Lot number of the reel.
        ReelID:
          description: Reel identifier.
        LabelType:
          description: Label type of the SKU.
      description: One available label.
  securitySchemes:
    accessKey:
      type: apiKey
      in: header
      name: AccessKey
      description: >-
        Send the `access` token returned by Login. Both `access` and `refresh`
        tokens are accepted; reserve `refresh` for credential renewal.

````

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