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

# Get Accounts

`GET /v4/shippingAccounts/dxf`

Retrieves a list of DX Freight shipping accounts created on your customer account. With this endpoint, you can view and manage multiple shipping accounts by using various query parameters for filtering, pagination, and sorting the list of accounts, making it easier for users to find specific accounts.

## 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 for the given carrier.

- DXFreightShippingAccountShippingAccountsPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `ShippingAccounts` DXFreightShippingAccount[], required — An array containing the shipping accounts associated with the shipping location that match the query parameters specified in the request.
    - `ShippingAccountId` string, uuid, required — A unique identifier for each shipping account assigned by the system (ShippingAccountId), 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.
    - `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 enabled, disabled, or confirmed, 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.
    - `OriginServiceCenter` string, required — A code that represents the customer account service centre from which the shipments originate.
    - `ServiceType` '1 Man' | '2 Man', required — A categorisation of the type of service used for shipments created by this shipping account. The accepted values are the following: <br /> <br />**• 1 Man**: This service type typically means that one crew member will handle the delivery. This is suitable for smaller, lighter items that one person can manage without assistance. <br /> <br />**• 2 Man**: This service type indicates that two personnel will be involved in the delivery process, which is often necessary for larger or heavier items that require additional handling or lifting.
    - `LastUpdatedBy` string, required — The identifier (such as a username or system account) of the individual or system that last modified the shipping account 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 that match the query parameters sent in the request, 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/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)