---
title: "Read external Ids of the customers"
method: GET
path: "/v1/customers/external-ids"
tags: ["Customer External Ids"]
---

# Read external Ids of the customers

`GET /v1/customers/external-ids`

## Request

- Base URL: `` (relative, and it does not resolve against the document’s source URL)
- URL: `/v1/customers/external-ids`
- 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/customers/external-ids/get.ts> (a function with typed inputs; its response is checked against the schema)

External Ids are the ones from different commerce systems. This endpoint enables the API user to read the external Ids of the Erply customers.

## Query parameters

- `externalIds` string[]
- `customerIds` integer[]
- `integrationName` string
- `skip` integer
- `take` integer

## Response `200`

OK

- ExternalIDResponse[]
  - `added` integer: Unix timestamp
  - `addedby_id` integer: user ID
  - `changed` integer: Unix timestamp
  - `changedby_id` integer: user ID
  - `customerId` integer
  - `externalId` string
  - `integrationName` string

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