---
title: "GET /v1/customer"
method: GET
path: "/v1/customer"
tags: ["Customer"]
---

# GET /v1/customer

`GET /v1/customer`

## Query parameters

- `remoteId` string
- `phoneNumber` string
- `email` string
- `subscriberCustomerId` string
- `externalUserId` string

## Response `200`

Customer found

- CustomerResponseDTO
  - `firstName` string — The first name of the customer
  - `lastName` string — The last name of the customer
  - `email` string, email — The email of the customer
  - `phoneNumber` string — The phone number of the customer (in international / E.164 format)
  - `displayName` string — The display name of the customer
  - `remoteId` string — The id of the customer in the ticketing system. For the SDK this needs to be stable and unique
  - `subscriberCustomerId` string — The id of the customer in your own primary database or a unique identifier, for example a cookie
  - `subscriberToken` string — A token that can be used to authenticate the customer in the your system, like a JWT
  - `avatarUrl` string — The URL of the customer avatar
  - `id` string, uuid, required — The id of the customer in the subscriber system
  - `externalUserId` string — The messaging-platform user id of the customer (e.g. the WhatsApp BSUID). Not a phone number.
  - `createdAt` string, date-time, required — The timestamp of the when the customer was created in our system

## Other responses

- `400` — Must provide exactly one of: remoteId, phoneNumber, email, subscriberCustomerId, externalUserId
- `404` — Customer not found

## Changes

- **2026-06-04** `9de61a54a2b1` — 2 info
  - added the new optional `query` request parameter `externalUserId`
  - added the optional property `externalUserId` to the response with the `200` status
- **2026-04-01** `fa5415682722` — 1 info
  - added the new optional `query` request parameter `subscriberCustomerId`
- **2026-03-21** `e4ead09b2162` — 1 info
  - added the new optional `query` request parameter `email`
- **2026-02-11** `b4f394f05daf` — 1 info
  - the endpoint scheme security `lorikeetClientId AND lorikeetSignatureAuthV1` was removed from the API
- **2026-01-28** `3a67275d43b9` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/optechai/apis/lorikeet-api/changes/v1/customer/get.md)

---

[API](https://skmtc.dev/optechai/apis/lorikeet-api.md) · [All operations](https://skmtc.dev/optechai/apis/lorikeet-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/optechai/lorikeet-api/revisions/789c7fa93584/schema)