---
title: "Get Addresses"
method: GET
path: "/v4/addresses"
tags: ["Address Book"]
---

# Get Addresses

`GET /v4/addresses`

Retrieve a list of shipping addresses for your customer account in the system. With this endpoint, you can get specific addresses based on various parameters, providing pagination and sorting features to help manage results effectively.

## Query parameters

- `searchTerm` string
- `pageSize` integer
- `pageNumber` integer
- `sortBy` 'ContactName' | 'CompanyName' | 'Town' | 'CountryCode' | 'ContactEmail' | 'LastModified' — Sort By
- `sortDir` 'Ascending' | 'Descending' — Order Direction

## Response `200`

Returns a list of addresses.

- AddressBookPagedResponse — The paged response containing the entities for the requested page only, and the total number available.
  - `Addresses` AddressBookList[], required — An array that contains the individual address records retrieved by the API. Each record includes detailed information about a specific address and its associated contact details.
    - `AddressId` string, nullable — A unique identifier for each address record. This information ensures that each address can be distinctly referenced and managed within the system.
    - `ContactName` string, nullable — The name of the primary contact associated with the address. This field is essential for identification and communication purposes.
    - `CompanyName` string, nullable — The name of the company linked to the address. This field provides context for the address, especially in business-related queries.
    - `ContactEmail` string, email, nullable — The email address of the primary contact for the address. This is used for correspondence and can facilitate communication directly related to the address.
    - `ContactPhone` string, tel, nullable — The phone number of the primary contact associated with the address. This field is crucial for any immediate communication needs.
    - `Line1` string, required — The first line of the address, typically containing the primary address information such as house number and street name.
    - `Line2` string, nullable — An optional second line for the address, often used for additional details like apartment numbers or suite designations.
    - `Line3` string, nullable — A third optional line in the address to include any further address specifications, allowing for more detailed address information if necessary.
    - `Town` string, required — The town or city, indicating the specific locality where the address is located.
    - `Postcode` string, nullable — The postal or ZIP code corresponding to the address, used to identify specific geographic areas.
    - `County` string, nullable — The county, state, or province in which the address is located, providing additional geographical context for the address.
    - `CountryCode` string, required — An abbreviation representing the country of the address, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.
    - `What3Words` string, nullable — A three-word location identifier provided by the What3words service, offering a precise way to define addresses using a unique combination of three words, for example, the front door of 10 Downing Street in London is identified by slurs.this.shark.
    - `LastUpdatedDateUtc` string, date-time — A timestamp in Coordinated Universal Time (UTC) indicating when the address record was last updated.This helps users understand the recency of the address information.
    - `LastUpdatedBy` string, nullable — The identifier of the user or system that last modified the address details, ensuring accountability and traceability for updates.
  - `TotalCount` integer, required — An integer representing the total number of address records that match the search criteria. This count provides users with an overview of how many address records are available based on the filters applied.

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