---
title: "Get addresses"
method: GET
path: "/v1/addresses"
tags: ["Addresses"]
---

# Get addresses

`GET /v1/addresses`

## Request

- Base URL: `` (relative, and it does not resolve against the document’s source URL)
- URL: `/v1/addresses`
- Auth: one of:
  - API key in header `sessionKey`
  - API key in header `clientCode`
  - API key in header `jwt`
- TypeScript: <https://skmtc.dev/erply/apis/crm-api/docs/v1/addresses/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `match` string
- `ids` integer[]
- `changed` integer
- `customerIds` integer[]
- `typeIds` integer[]
- `street` string
- `address2` string
- `postCode` string
- `city` string
- `country` string
- `state` string
- `orderBy` string
- `orderByDirection` 'ASC' | 'DESC'
- `skip` integer
- `take` integer
- `withTotalCount` boolean

## Response `200`

OK

- CustomersApiInternalModelsCustomerAddressResponse[]
  - `added` integer: Unix timestamp
  - `addedBy` string: username
  - `address2` string: Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!
  - `changed` integer: Unix timestamp
  - `changedBy` string: username
  - `city` string
  - `country` string
  - `customerId` integer
  - `id` integer: object ID
  - `postCode` string: Postal code or ZIP code.
  - `state` string: State. This field is exposed via Erply user interface only for US, CA and MX accounts!
  - `street` string: Street address. If address cannot be split into parts, put the whole address into this field.
  - `typeId` integer

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/erply/apis/crm-api.md) - [All operations](https://skmtc.dev/erply/apis/crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/erply/apis/crm-api/revisions/36dd4cc370b2?raw)