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

> Returns a direct array of carriers, each with `CarrierName` and `CarrierID`. Use a returned `CarrierID` when creating or editing an asset.

By default, returns four carriers: UPS, USPS, FedEx, and DHL.

`CarrierID` narrows the array to that carrier. The response is still an array, and it is empty when nothing matches. Results are returned in a single response. Look up carriers when you configure your integration and reuse the result instead of requesting the list before every asset operation.



## OpenAPI

````yaml /openapi/openapi.json get /Carriers/GetCarriers
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:
  /Carriers/GetCarriers:
    get:
      tags:
        - Carriers
      summary: List carriers
      description: >-
        Returns a direct array of carriers, each with `CarrierName` and
        `CarrierID`. Use a returned `CarrierID` when creating or editing an
        asset.


        By default, returns four carriers: UPS, USPS, FedEx, and DHL.


        `CarrierID` narrows the array to that carrier. The response is still an
        array, and it is empty when nothing matches. Results are returned in a
        single response. Look up carriers when you configure your integration
        and reuse the result instead of requesting the list before every asset
        operation.
      operationId: get_carriers_Carriers_GetCarriers_get
      parameters:
        - name: CarrierID
          in: query
          required: false
          schema:
            type: string
          description: >-
            Return only the carrier with this identifier. The response remains
            an array.
          example: '00000000000000000000000000000004'
        - name: AccountID
          in: query
          description: Account identifier. Defaults to your account.
          schema:
            type: string
          example: '00000000000000000000000000000002'
      responses:
        '200':
          description: >-
            Successful response. A direct array of carriers, empty when none
            match.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CarrierRecord'
              example:
                - CarrierName: Example Carrier
                  CarrierID: '00000000000000000000000000000004'
        '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:
    CarrierRecord:
      type: object
      properties:
        CarrierName:
          type: string
          description: Name of the carrier.
        CarrierID:
          type: string
          description: >-
            Unique identifier of the carrier. Use it as `CarrierID` when
            creating or editing an asset.
      description: One carrier.
    ApiError:
      type: object
      properties:
        Code:
          type: integer
          description: Application error code.
        Message:
          type: string
          description: Error message.
      description: Request error.
  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.