client/v1/list/customers
[GET] client/v1/list/customers
Get customer list
Allows Client Admin to retrieve a list of their customers. The customer list implements pagination and defaults to 10 customers per page. Request parameters can be added to the URI to filter results and control pagination. See the table at the bottom of this page for examples.
Example [GET] Request
{{avenu_base_url}}/client/v1/list/customers
Example Response
{
"pagination": {
"next": "client/v1/list/customers?limit=1&page=2",
"totalCustomers": 1389
},
"customers": [
{
"accountNumber": "",
"firstName": "",
"lastName": "",
"emailAddress": "",
"address": "",
"city": "",
"state": "",
"zipCode": "",
"country": "",
"citizenship": "",
"mobilePhone": "",
"accountStatus": ""
}
]
}
Response Elements
Element | Details |
---|---|
"accountNumber" | The customer's Avenu client account number |
"firstName" | The customer's first name |
"lastName" | The customer's last name |
"emailAddress" | The customer's email address |
"address" | The customer's physical street address |
"city" | The customer's city |
"state" | The customer's state |
"zipCode" | The customer's zip code |
"country" | The address' country |
"citizenship" | The customer's citizenship |
"mobilePhone" | The customer's mobile phone |
"accountStatus" | The current status of the customer's account |
Optional Request Parameters
Parameter | Format | Required | Example |
---|---|---|---|
limit | Int | N (if not passed, the default returns a limit of 10) | ?limit=50 |
accountNumber | String | N | ?accountNumber=9876543210 |
firstName | String | N | ?firstName=Mike |
lastName | String | N | ?lastName=Jones |
address | String | N | ?address=565 Main Street |
city | String | N | ?city=Fairfax |
state | String | N | ?state=VA |
zipCode | String | N | ?zipCode=22031 |
country | String | N | ?country=USA |
citizenship | String | N | ?citizenship=USA |
mobilePhone | String | N | ?mobilePhone=123-456-7890 |
Updated 7 months ago