Skip to main content
GET
/
customers
/
{id}
Get customer by external ID
curl --request GET \
  --url http://localhost:3156/customers/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-merchant-id: <api-key>'
{
  "externalId": "CUST-123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phoneNumber": "+1234567890",
  "active": true,
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication (required)

​
x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Path Parameters

​
id
string
required

External customer ID

Response

Customer details retrieved successfully

​
externalId
string

External customer ID from merchant system

Example:

"CUST-123"

​
firstName
string

Customer's first name

Example:

"John"

​
lastName
string

Customer's last name

Example:

"Doe"

​
email
string<email>

Customer's email address

Example:

"john.doe@example.com"

​
phoneNumber
string

Customer's phone number

Example:

"+1234567890"

​
active
boolean

Whether the customer is active

Example:

true

​
notificationOptions
object

Customer notification preferences

​
createdAt
string<date-time>

Customer creation timestamp

Example:

"2024-03-20T10:00:00Z"

​
updatedAt
string<date-time>

Customer last update timestamp

Example:

"2024-03-20T10:00:00Z"