Skip to main content
POST
https://api.laudspeaker.com
/
customers
/
read
Read
curl --request POST \
  --url https://api.laudspeaker.com/customers/read \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primary_key": "<string>"
}
'
{
  "email":"test@example.com",
  "first_name":"John",
  "last_name":"Doe",
  "phone_number":"123-456-7890"
}
The read endpoint is designed to allow Laudspeaker users the programmatic ability to read existing customers. The read endpoint looks up a customer document using the supplied primary_key, returning the customer’s key/value pairs. If the customer does not exist, an error is returned.
In order to use this endpoint, a primary key must have first been selected via the Laudspeaker UI.

​
Authentication

​
Authorization
string
required
Header for authenticating with Laudspeaker. Starts with Api-Key followed by the API key, for example Api-Key M4jxXt6diYz1Dds1YmhHe93KGPAUi24PlXgaiRXi.

​
Body

​
primary_key
string
required
This field specifies the primary key value used to uniquely identify users.

​
Response

{
  "email":"test@example.com",
  "first_name":"John",
  "last_name":"Doe",
  "phone_number":"123-456-7890"
}
​
primary_key
string
required
The primary key of the customer object that was found.

​
Example

​
Reading a customer

curl --request POST \
  --url https://api.laudspeaker.com/customers/read \
  --header 'Authorization: Api-Key M4jxXt6diYz1Dds1YmhHe93KGPAUi24PlXgaiRXi' \
  --header 'Content-Type: application/json' \
  --data '{
  "primary_key": "test@example.com"
}'