Users
Read
Reading customers programmatically via the Laudspeaker API
POST
/
customers
/
read
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
requiredHeader for authenticating with Laudspeaker. Starts with Api-Key followed by the API key, for example Api-Key M4jxXt6diYz1Dds1YmhHe93KGPAUi24PlXgaiRXi.
Body
primary_key
string
requiredThis field specifies the primary key value used to uniquely identify users.
Response
primary_key
string
requiredThe primary key of the customer object that was found.