---
title: "Get Accounts"
method: GET
path: "/v4/ShippingAccounts"
tags: ["Shipping Accounts"]
---

# Get Accounts

`GET /v4/ShippingAccounts`

Retrieves a list of all shipping accounts for all carriers created on your customer account.

## Query parameters

- `searchTerm` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'Name' | 'Alias' | 'LastModified' | 'CarrierAccountNumber' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction

## Response `200`

Returns a paged list of shipping accounts.

- ShippingAccountsPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `ShippingAccounts` ShippingAccount[], required — An array containing all shipping accounts associated with the shipping location for the specific page only.
    - `ShippingAccountId` string, uuid, required — A unique identifier for each shipping account assigned by the system **(ShippingAccountId)** or by you **(AccountAlias)**, allowing for efficient reference and management of individual accounts within the system.
    - `CarrierCode` string, required — A unique identifier for the carrier associated with the shipping account. This code is typically alphanumeric and helps in identifying the specific carrier linked to the shipping account.
    - `AccountNumber` string, required — The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.
    - `AccountType` 'Sandbox' | 'Production', required — Indicates whether the account is set up as a "sandbox" or "production" account. A **Sandbox** account is for testing and development, while a **Production** account is used for live shipments and transactions.
    - `AccountName` string, required — The official name of the shipping account as designated by the user or organisation, aiding in easy identification and reference of accounts. <br /> <br />***Note:** By default, this value is set to the customer name.*
    - `AccountAlias` string, required — A unique, user-defined name for the shipping account, providing a convenient way to reference the account in a more memorable manner.
    - `AccountStatus` string, required — The current status of the shipping account, which could denote whether it is active, inactive, or suspended, helping users understand the account's usability.
    - `ContactName` string, required — The name of the primary contact person for the shipping account, facilitating communication regarding shipping and account-related matters.
    - `ContactNumber` string, tel, required — The phone number associated with the shipping account's primary contact person, facilitating communication regarding shipping inquiries, account management, and issue resolution. <br /> <br />***Note**: Characters like +, /, -, or space are supported.*
    - `LastUpdatedBy` string, required — The identifier (such as a username or system account) of the individual or system that last modified the shipping location information, ensuring accountability.
    - `LastUpdatedDateUtc` string, date-time, required — A timestamp indicating the last time the shipping account details were updated, formatted in Coordinated Universal Time (UTC).
  - `TotalCount` integer, required — An integer representing the total number of shipping accounts associated with the specified shipping location, giving users a quick overview of how many accounts are linked to their operations.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/proshipping/apis/pro-shipping-core-api.md) · [All operations](https://skmtc.dev/proshipping/apis/pro-shipping-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/proshipping/pro-shipping-core-api/revisions/ae5fc5e90109/schema)