Customer

A customer object is a representation of a customer that can be found in the customer panel.

Please select a version:

Structure

Parameter Description Remarks
Id A unique identifier of the customer An integer
Name Name of the customer A string of max 100 characters.
Email The email of the customer. A string of max 100 characters.
CompanyName Company name of the customer A string of max 100 characters.
Created Creation date of the customer A DateTime.

Result

Example for model version 1. For an example that includes Secret, see GetCustomers with ModelVersion=2.

{"id":1234,"name":"Bob","email":"bob@example.com","companyName":"SKM","created":"2015-09-04T16:11:14.453"}

FAQ

Can I retrieve a customer secret through the API?

Yes. The Secret field is included in customer model versions 2 and 3; version 1 omits it. Call GetCustomers with ModelVersion=2, an exact CustomerId, and a token granting GetCustomers. For example, a matching owned customer is returned in customers with a secret field. See the linked request and response example.