Skip to main content
Assumed ModelVersion: 3 (highest documented version at generation time) A customer object is a representation of a customer that can be found in the customer panel.

Structure

Result

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

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.