Get Customer List W Branch Id
GET
/api/v1/customers
Customer List
Purpose
Why would you use this?
Information Required
| Field | Required | Description |
|---|---|---|
| api-token | Yes | Authentication token provided by VasyERP |
| limit | Yes | Number of customer records to retrieve per request |
| offset | Yes | Number of records to skip for pagination |
Information Returned
| Field | Description |
|---|---|
| contactId | Unique identifier of the customer |
| customerName | Customer name |
| mobileNo | Customer mobile number |
| Customer email address | |
| gstNo | Customer GST number (if available) |
| customerType | Type of customer |
| loyaltyPoints | Customer loyalty points |
| branchId | Associated branch identifier |
Example Use Case
Important Notes
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/customers?offset=0&limit=1&branch_id=24448' \
--header 'api-token: {{.in-api-token}}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Customer List",
"code": "200",
"response": {
"totalCount": 25,
"contactList": [
{
"firstName": "9991482617",
"lastName": "",
"contactId": 5313756,
"companyName": "",
"mobNo": "9991482617",
"telephone": "",
"whatsAppNo": "",
"email": "",
"dateOfBirth": null,
"anniversaryDate": null,
"gstType": "UnRegistered",
"gstin": "",
"pan": "",
"stateName": "Haryana",
"countryName": "India",
"cityName": "GURUGRAM",
"contactType": "",
"status": false,
"countryDialCodePrefix": 0,
"countryDialCodePrefixWhatsapp": 0,
"lastModifiedOn": "2026-05-26 11:44:03.038461+05:30",
"lastModifiedBy": "my business",
"loyaltyPoints": 0,
"branchName": "my business",
"branchId": 24448,
"accountCustomId": 6126139
}
]
}
}