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

# List supported shipment carriers

> Returns supported carriers for shipment tracking. You can optionally filter carriers by tracking platform.



## OpenAPI

````yaml /openapi.json get /api/v1/carriers
openapi: 3.1.0
info:
  title: Firstbase API Specification Beta
  description: Integration endpoints for Firstbase
  version: 0.1.0
servers:
  - url: /
    description: Default
security:
  - ApiKey: []
tags:
  - name: Inventory Orders
    description: Create and manage inventory orders
  - name: Shipment Notices V1
    description: 'Query shipment notice orders (V1: package items expose `inventories` list)'
  - name: Packages
    description: ''
  - name: Categories
    description: Query available categories for asset creation
  - name: Catalog
    description: ''
  - name: New Joiners
    description: New joiner provisioning pipeline for the organization
  - name: Orders
    description: ''
  - name: People
    description: >-
      Manage the users of Firstbase for your organization. API follows the SCIM
      standard.
    externalDocs:
      url: https://scim.cloud/
  - name: People — Lifecycle
    description: Offboard and reactivate users.
  - name: Assets
    description: Manage inventory assets
  - name: Regions V1
    description: Query regions (V1)
  - name: Warehouses V1
    description: Query warehouses (V1)
  - name: Brands
    description: Query available brands for asset creation
  - name: Inventory
    description: ''
  - name: Replacements
    description: Create and manage equipment replacements
  - name: Offices
    description: Manage and query office locations for the authenticated organization
  - name: Returns
    description: Return and Replacements
paths:
  /api/v1/carriers:
    get:
      tags:
        - Shipment
      summary: List supported shipment carriers
      description: >-
        Returns supported carriers for shipment tracking. You can optionally
        filter carriers by tracking platform.
      operationId: listShipmentCarriers
      parameters:
        - name: platform
          in: query
          description: >-
            Optional tracking platform to filter carriers by. One of: EASYPOST,
            AFTERSHIP.
          required: false
          schema:
            type: string
            enum:
              - EASYPOST
              - AFTERSHIP
          example: EASYPOST
      responses:
        '200':
          description: List of supported carriers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CarrierTypeDto'
        '400':
          description: Bad request — invalid platform parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
components:
  schemas:
    CarrierTypeDto:
      type: object
      properties:
        carrier:
          type: string
          description: The carrier code to use with shipment tracking requests
          example: UPS
        displayName:
          type: string
          description: Carrier display name
          example: UPS
      required:
        - carrier
        - displayName
    PublicApiHttpErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiError'
      required:
        - errors
    PublicApiError:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable description of the error
          example: Invalid request
        source:
          type: string
          description: >-
            Entity or field path that caused the error (for example order,
            shipmentNotice, or person:email)
          example: request
      required:
        - detail
        - source
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Prefix the value with "ApiKey" to indicate the custom authorization type
      name: Authorization
      in: header

````