---
title: "List carrier connections"
method: GET
path: "/v1/connections"
tags: ["Connections"]
---

# List carrier connections

`GET /v1/connections`

Retrieve all carrier connections

## Query parameters

- `active` boolean
- `carrier_name` string
- `metadata_key` string
- `metadata_value` string
- `system_only` boolean

## Response `200`

- CarrierConnectionList
  - `count` integer, nullable
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` CarrierConnection[], required
    - `id` string, required — A unique carrier connection identifier
    - `object_type` string — Specifies the object type
    - `carrier_name` 'allied_express' | 'allied_express_local' | 'amazon_shipping' | 'aramex' | 'asendia_us' | 'australiapost' | 'boxknight' | 'bpost' | 'canadapost' | 'canpar' | 'chronopost' | 'colissimo' | 'dhl_express' | 'dhl_parcel_de' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'easyship' | 'eshipper' | 'fedex' | 'fedex_ws' | 'freightcom' | 'generic' | 'geodis' | 'hay_post' | 'laposte' | 'locate2u' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sapient' | 'seko' | 'sendle' | 'tge' | 'tnt' | 'ups' | 'usps' | 'usps_international' | 'usps_wt' | 'usps_wt_international' | 'zoom2u', required — A carrier connection type.
    - `display_name` string — The carrier connection type verbose name.
    - `carrier_id` string, required — A carrier connection friendly name.
    - `credentials` union
      - Zoom2u
        - `api_key` string, required
      - UspsWtInternational
        - `username` string, required
        - `password` string, required
        - `mailer_id` string
        - `customer_registration_id` string
        - `logistics_manager_mailer_id` string
      - UspsWt
        - `username` string, required
        - `password` string, required
        - `mailer_id` string
        - `customer_registration_id` string
        - `logistics_manager_mailer_id` string
      - UspsInternational
        - `client_id` string, required
        - `client_secret` string, required
        - `account_number` string
        - `account_type` 'EPS' | 'PERMIT' | 'METER' — Indicates a account_type string
        - `manifest_MID` string
        - `CRID` string
        - `MID` string
      - Usps
        - `client_id` string, required
        - `client_secret` string, required
        - `account_number` string
        - `account_type` 'EPS' | 'PERMIT' | 'METER' — Indicates a account_type string
        - `manifest_MID` string
        - `CRID` string
        - `MID` string
      - Ups
        - `client_id` string, required
        - `client_secret` string, required
        - `account_number` string
        - `account_country_code` string
      - Tnt
        - `username` string, required
        - `password` string, required
        - `account_number` string
        - `account_country_code` string
      - Tge
        - `username` string, required
        - `password` string, required
        - `api_key` string, required
        - `toll_username` string, required
        - `toll_password` string, required
        - `my_toll_token` string, required
        - `my_toll_identity` string, required
        - `account_code` string
        - `sscc_count` integer
        - `shipment_count` integer
      - Sendle
        - `sendle_id` string, required
        - `api_key` string, required
        - `account_country_code` string
      - Seko
        - `access_key` string, required
      - Sapient
        - `client_id` string, required
        - `client_secret` string, required
        - `shipping_account_id` string, required
        - `sapient_carrier_code` 'DX' | 'EVRI' | 'RM' | 'UPS' | 'YODEL' — Indicates a sapient_carrier_code string
      - Royalmail
        - `client_id` string, required
        - `client_secret` string, required
      - Roadie
        - `api_key` string, required
      - Purolator
        - `username` string, required
        - `password` string, required
        - `account_number` string, required
        - `user_token` string
        - `language` 'en' | 'fr' — Indicates a language string
      - Nationex
        - `api_key` string, required
        - `customer_id` string, required
        - `billing_account` string
        - `language` 'en' | 'fr' — Indicates a language string
      - Locate2u
        - `client_id` string
        - `client_secret` string
      - Laposte
        - `api_key` string, required
        - `lang` 'fr_FR' | 'en_US' — Indicates a lang string
      - HayPost
        - `username` string, required
        - `password` string, required
        - `customer_id` string, required
        - `customer_type` string, required
      - Geodis
        - `api_key` string, required
        - `identifier` string, required
        - `code_client` string
        - `language` 'fr' | 'en' — Indicates a language string
      - Generic
        - `display_name` string, required
        - `custom_carrier_name` string, required
        - `account_country_code` string
        - `account_number` string
      - Freightcom
        - `username` string, required
        - `password` string, required
      - FedexWs
        - `password` string, required
        - `meter_number` string, required
        - `account_number` string, required
        - `user_key` string
        - `language_code` string
        - `account_country_code` string
      - Fedex
        - `api_key` string
        - `secret_key` string
        - `account_number` string
        - `track_api_key` string
        - `track_secret_key` string
        - `account_country_code` string
      - Eshipper
        - `principal` string, required
        - `credential` string, required
      - Easyship
        - `access_token` string, required
      - Easypost
        - `api_key` string, required
      - Dpdhl
        - `username` string, required
        - `password` string, required
        - `app_id` string
        - `app_token` string
        - `zt_id` string
        - `zt_password` string
        - `account_number` string
      - Dpd
        - `delis_id` string, required
        - `password` string, required
        - `depot` string
        - `message_language` string
        - `account_country_code` string
      - Dicom
        - `username` string, required
        - `password` string, required
        - `billing_account` string
      - DhlUniversal
        - `consumer_key` string, required
        - `consumer_secret` string, required
        - `language` 'en' | 'de' — Indicates a language string
      - DhlPoland
        - `username` string, required
        - `password` string, required
        - `account_number` string
      - DhlParcelDe
        - `username` string, required
        - `password` string, required
        - `dhl_api_key` string, required
        - `customer_number` string
        - `tracking_consumer_key` string
        - `tracking_consumer_secret` string
      - DhlExpress
        - `site_id` string, required
        - `password` string, required
        - `account_number` string
        - `account_country_code` string
      - Colissimo
        - `password` string, required
        - `contract_number` string, required
        - `laposte_api_key` string
      - Chronopost
        - `account_number` string, required
        - `password` string, required
        - `id_emit` string
        - `language` 'en_GB' | 'fr_FR' — Indicates a language string
      - Canpar
        - `username` string, required
        - `password` string, required
        - `language` 'en' | 'fr' — Indicates a language string
      - Canadapost
        - `username` string, required
        - `password` string, required
        - `customer_number` string
        - `contract_id` string
        - `language` 'en' | 'fr' — Indicates a language string
      - Bpost
        - `account_id` string, required
        - `passphrase` string, required
      - Boxknight
        - `username` string, required
        - `password` string, required
      - Australiapost
        - `api_key` string, required
        - `password` string, required
        - `account_number` string, required
      - AsendiaUs
        - `username` string, required
        - `password` string, required
        - `api_key` string, required
        - `account_number` string
      - Aramex
        - `username` string, required
        - `password` string, required
        - `account_pin` string, required
        - `account_entity` string, required
        - `account_number` string, required
        - `account_country_code` string, required
      - AmazonShipping
        - `seller_id` string, required
        - `developer_id` string, required
        - `mws_auth_token` string, required
        - `aws_region` string
        - `account_country_code` string
      - AlliedExpressLocal
        - `username` string, required
        - `password` string, required
        - `account` string
        - `service_type` 'R' | 'P' | 'PT' | 'PT2' — Indicates a service_type string
      - AlliedExpress
        - `username` string, required
        - `password` string, required
        - `account` string
        - `service_type` 'R' | 'P' | 'PT' | 'PT2' — Indicates a service_type string
    - `capabilities` string[], nullable — The carrier enabled capabilities.
    - `config` object — Carrier connection custom config.
    - `metadata` object — User metadata for the carrier.
    - `is_system` boolean, required — The carrier connection is provided by the system admin.
    - `active` boolean, required — The active flag indicates whether the carrier account is active or not.
    - `test_mode` boolean, required — The test flag indicates whether to use a carrier configured for test.

## Other responses

- `400`

---

[API](https://skmtc.dev/karrio/apis/karrio-api.md) · [All operations](https://skmtc.dev/karrio/apis/karrio-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/karrio/karrio-api/revisions/76ab3b7c3a61/schema)