---
title: "Get Carrier Credentials"
method: GET
path: "/commerce/shipping/admin/carriers/credentials"
tags: ["CarrierCredential"]
---

# Get Carrier Credentials

`GET /commerce/shipping/admin/carriers/credentials`

Returns a collection of all carrier credentials

## Query parameters

- `startIndex` integer
- `pageSize` integer
- `sortBy` string
- `filter` string
- `responseFields` string

## Response `200`

Success

- CarrierCredentialCollection — A collection of <see cref="T:Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredential">carrier credentials</see>.
  - `items` CarrierCredential[], nullable
    - `auditInfo` AdminUserAuditInfo
      - `createBy` string, nullable
      - `createDate` string, date-time, nullable
      - `updateBy` string, nullable
      - `updateDate` string, date-time, nullable
    - `carrierId` string, nullable — The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").
    - `credentialSet` CarrierCredentialSet — Stores a set of <see cref="T:Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSetValue">carrier credential key-value pairs</see>. Sets are stored at the tenant level and referenced by a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredential.
      - `auditInfo` AdminUserAuditInfo
        - `createBy` string, nullable
        - `createDate` string, date-time, nullable
        - `updateBy` string, nullable
        - `updateDate` string, date-time, nullable
      - `carrierId` string, nullable — The Carrier ID associated with this credential set. Usually the short name of a carrier (e.g., "FedEx").
      - `code` string, nullable — A unique code identifying this credential set. The code is only guaranteed to be unique at the tenant and carrier level.
      - `integrationId` string, nullable — Specifies the ID returned from an integration.
      - `name` string, nullable — A name (i.e., nickname) for this credential set.
      - `values` CarrierCredentialSetValue[], nullable — A collection of values contained in this credential set.
        - `key` string, nullable
        - `value` string, nullable
    - `locationCode` string, nullable — The Location Code associated with this carrier credential, if any.
    - `locationGroupCode` string, nullable — The Location Group Code associated with this carrier credential, if any.
    - `siteId` integer, nullable — The Site ID associated with this carrier credential, if any.
  - `pageCount` integer
  - `pageSize` integer
  - `startIndex` integer
  - `totalCount` integer

---

[API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)
