1. Contact
VasyOpenAPI
  • Branch
    • Branch List
      GET
  • Department
    • department
      GET
  • Category
    • category
      GET
    • subCategory
      GET
  • Brand
    • Brand
      GET
    • SubBrand
      GET
  • Contact
    • Get Customer List W Branch Id
      GET
    • Get Contact By Id
      GET
    • Get Contact By Mobile No
      GET
    • contactSave
      POST
    • Supplier(Party)
      GET
  • GST
    • Verify GST
      POST
  • Master
    • Get Country List
      GET
    • Get State List
      GET
    • Get City List
      GET
    • Get Tax List
      GET
    • Get Additional Charge List
      GET
  • Product
    • Get Product List
      GET
    • Get Product By ID
      GET
    • products with inventory
      GET
    • product details with Inventory By Product ID
      GET
    • Product Variant List ID & Name
      GET
    • Variant Details By Variant ID
      GET
  • Recipe
    • Get All Recipe
  • User
    • Created By
  • Report
    • Get Sales Item Register Data
    • Purchase Item Register Report
    • Stock Summary Report
    • Stock Transfer Item Register Report
    • Consumption Production Report
  • Sales
    • Get All Sales Data
    • Get Sales Data By Id
    • Order Create
    • Order Status
    • Shipping Details
    • Update Due Date
    • Update Order Status
  1. Contact

Get Contact By Mobile No

GET
/api/v1/customer/0

Contact By Mobile Number#

Purpose#

Retrieve customer details using the customer's mobile number.

Why would you use this?#

Use this API when you have the customer's mobile number but do not have the Contact ID. This API helps locate and retrieve customer information stored in VasyERP.

Information Required#

FieldRequiredDescription
api-tokenYesAuthentication token provided by VasyERP
contact_noYesCustomer mobile number registered in VasyERP
branch_idNoBranch identifier. If not provided, the Head Office (HO) branch will be used by default.

Information Returned#

This API returns detailed customer information associated with the provided mobile number, including:
Customer Name
Contact ID
Mobile Number
Email Address
GST Information
Address Details
Loyalty Points
Branch Information

Example Use Case#

A customer logs in to an eCommerce website using their mobile number.
The website needs to determine whether the customer already exists in VasyERP and retrieve their customer information without first fetching the Customer List.
Using this API, the system can search for the customer directly using the mobile number.

Important Notes#

The mobile number must exist in VasyERP.
If multiple customers share the same mobile number, the returned result may depend on business configuration.
If branch_id is not provided, the API automatically uses the Head Office (HO) branch.
The response includes the customer's Contact ID, which should be stored and used for future customer-related operations.

Common Mistakes#

āŒ Passing an invalid or unregistered mobile number
āŒ Using customer name instead of mobile number
āŒ Expecting branch-specific results without providing branch_id

Request

Query Params

Header Params

Responses

šŸŸ¢200
application/json
Bodyapplication/json

šŸŸ 403Unauthorized
šŸŸ 429Too Many Request
šŸŸ 400BranchID Validation
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/customer/0?branch_id=24448&contact_no=9991482617' \
--header 'api-token: {{.in-api-token}}'
Response Response Example
200 - Example
{
    "status": true,
    "message": "Contact Detail",
    "code": "200",
    "response": {
        "firstName": "9991482617",
        "lastName": "",
        "contactId": 5313756,
        "companyName": "",
        "mobNo": "9991482617",
        "telephone": "",
        "whatsappNo": "",
        "email": "",
        "remark": "",
        "dateOfBirth": null,
        "anniversaryDate": null,
        "panNo": "",
        "contactType": "",
        "countryDialCodePrefix": 0,
        "countryDialCodePrefixWhatsapp": 0,
        "loyaltyPoints": 0,
        "lastModifiedOn": "2026-05-26 11:44:03.038461+05:30",
        "lastModifiedBy": "my business",
        "gstType": "",
        "gstin": "",
        "branchName": "my business",
        "contactAddress": [
            {
                "contactAddressId": 5278168,
                "addressLine1": "2374",
                "addressLine2": "Chiranjiv Park, C/2206, Sushant Lok Rd, Block C, Sushant Lok Phase I, Sector 43, Gurugram, Haryana 122009, India",
                "pinCode": "122009",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "GURUGRAM",
                "stateName": "Haryana",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": true
            },
            {
                "contactAddressId": 5278303,
                "addressLine1": "Test Ananda",
                "addressLine2": "Sec 82",
                "pinCode": "122012",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "GURUGRAM",
                "stateName": "Haryana",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": false
            },
            {
                "contactAddressId": 5278174,
                "addressLine1": "Test",
                "addressLine2": "Saini Khera Village",
                "pinCode": "122001",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "GURUGRAM",
                "stateName": "Haryana",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": false
            },
            {
                "contactAddressId": 5278173,
                "addressLine1": "D-75",
                "addressLine2": "Suncity",
                "pinCode": "122011",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "GURUGRAM",
                "stateName": "Haryana",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": false
            },
            {
                "contactAddressId": 5278172,
                "addressLine1": "101",
                "addressLine2": "Kapashera",
                "pinCode": "110097",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "New Delhi",
                "stateName": "Delhi",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": false
            },
            {
                "contactAddressId": 5278169,
                "addressLine1": "3rd floor",
                "addressLine2": "2375, opposite Vyapar Kendra Road, Block C, Sushant Lok Phase I, Sector 43, Gurugram, Haryana 122009, India",
                "pinCode": "122009",
                "gstType": "UnRegistered",
                "gstin": null,
                "firstName": "9991482617",
                "lastName": null,
                "companyName": null,
                "panNo": null,
                "contactNo": "9991482617",
                "contactEmail": null,
                "cityName": "GURUGRAM",
                "stateName": "Haryana",
                "countriesName": "India",
                "countryDialCodePrefix": 0,
                "defaultAddress": false
            }
        ]
    }
}
Previous
Get Contact By Id
Next
contactSave
Built with