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

# Get Accounts

`GET /v4/shippingAccounts/evri`

Provides a list of Evri shipping accounts only.
<br />Information about the account number, account type, and contact details is included in the response.

## 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.

- EvriShippingAccountShippingAccountsPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `ShippingAccounts` EvriShippingAccount[], 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.
    - `ClientId` string, required — The ClientId used for the Evri API.
    - `ClientName` string, required — The Client Name used for the Evri API.
    - `Username` string, required — The username used for the Evri API.
    - `SmsAlertGroupCode` string, nullable — The alert group code that is allocated by Evri. Required if you use the SMS notification enhancement.
    - `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)