Get Customers
This method will return the list of customers, with the newest customers shown first.
This method is accessed by https://api.cryptolens.io/api/customer/GetCustomers
Parameters
Parameter |
Description |
Remarks |
Search |
If either the Name, Company, Email or the Secret contains the search string, it will be returned.
|
optional |
CustomerId |
If this is set, you can use the CustomerId field to find a specific customer based on their integer Id.
|
optional |
Limit |
Specifies how many customers will be returned. If not set, all customers will be returned. |
optional. disabled by default. |
ModelVersion |
The model that will be returned. In comparison to method version, this only affects what fields and information will be returned and does not
impact the way the method works. A changelog can be found in the end of this page.
|
optional. by default, it's 1. |
v |
Method version. |
optional. by default, it's 1. |
Results
Parameter |
Description |
Remarks |
Customers |
A list of Customer objects. |
always returned |
ResellerCustomers |
A list of Customer (extended) objects. These customers belong to a different user but you can still edit some of the fields. |
always returned |
VisibleCustomers |
A list of Customer (customer extended) objects. These customers belong to a different user but you can still view them. |
always returned |
Result |
This is either 0(=success) or 1(=error). |
always returned |
Message |
The message that provides additional information about the result.
|
always returned. |
Example results
{"customers":[{"id":1234,"name":"Bob","email":"bob@example.com","companyName":"SKM","created":"2015-09-04T16:11:14.453"}],"result":0,"message":null}
Errors
Model Versions
This changelog list changes of the returned fields given the model version.
- All customer objects that are returned will have the same fields as described here.
- The original model.