---
title: "Search Addresses"
method: GET
path: "/business/v2/addresses"
tags: ["Addresses"]
---

# Search Addresses

`GET /business/v2/addresses`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/addresses`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `address_read`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/addresses/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to search `Addresses`.

## Query parameters

- `userId` string: The `User` ID.
- `category` 'USER' | 'COMPANY'
- `p` integer: It indicates the specific page to display (the counter starts from zero).
- `s` integer: It indicates the number of items per page.
- `d` 'ASC' | 'DESC': It indicates how the pages are ordered.
- `props` string[]: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.

## Response `200`

The result is an array containing `Addresses`.

- Addresses
  - `total` integer: It represents the total number of available items in the list.
  - `pages` integer: It represents the total number of available pages.
  - `page_size` integer: It represents the number of items per page.
  - `current_page` integer: It indicates the current page (the counter starts from zero).
  - `results_size` integer: It indicates the size of the array results.
  - `results` Address[]
    - `id` string: The `Address` ID.
    - `recipient` string: The recipient of the `Address`
    - `name` string: The actual name of the `Address`.
    - `line1` string: The `Address` street.
    - `line2` string: An optional other street.
    - `country` string: The country of the `Address`.
    - `county` string: The county of the `Address`.
    - `city` string: The city of the `Address`.
    - `post_code` string: The postal code of the `Address`.
    - `delivery_phone_number` string: Delivery phone number
    - `default_shipping` boolean: True if the `Address` is the default shipping address.
    - `type` string: The type of the `Address`.
    - `category` 'USER' | 'COMPANY'
    - `user_id` string: The `User` ID, only if category of the `Address` is `USER`.
    - `creation_time` string: The date and time when the `Address` was created.
    - `last_update` string: The date and time when the `Address` was last updated.

## Other responses

- `400`: Your request has missing arguments or is malformed.

## Changes

- **2026-02-11** `e4706ef36e2a`: 7 warning, 16 info
  - removed the optional property `results/items/address_category` from the response with the `200` status
  - removed the optional property `results/items/address_type` from the response with the `200` status
  - removed the optional property `results/items/addressee_name` from the response with the `200` status
  - removed the optional property `results/items/addressee_surname` from the response with the `200` status
  - …19 more

[Operation history](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/changes/business/v2/addresses/get.md)

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)