Get a List of Customers

A list of customers can be retrieved for display.

URL Method
api/{apiKey}/customers GET

Parameters

Pass the following parameters on the URL string as shown above.

Parameter Description Required
{
ApiKey: "string", your api key *
}

Return Values

This API returns an array of the following in JSON format if the operation is successful.

Field Description
[
{
ID Customer's ID
Name
Code
PrimaryContact
PrimaryContactEmailAddress
PrimaryContactPhone
PaymentMethods null (diregard this field)
Success false (disregard this field)
Message null (disregard this field)
}
]