get_customer_by_phone
Testing Env
https://taccounting.vodoerp.com
Testing Env
https://taccounting.vodoerp.com
GET
/api/v4/get_customer_by_phone
Last modified:2025-04-28 11:19:09
| ** Query Param** | description |
|---|---|
| customer_phone | required string customer phone |
| search_by_keyword | optional string yes for search in part of phone no to search with full phone |
| HEADERS | description |
|---|---|
| Accept-Language | required stringar,en |
| secure-business-key | required string ex: 4765066450c0bd66325.48403130 from accounts system base on business |
| apikey | required string ex: efe2db322a53 for make reuest more secure must add apikey in header |
| platform-key | required string ex: 1234567 use this value as test |
| platform | required string ex: web use this value as test |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://taccounting.vodoerp.com/api/v4/get_customer_by_phone?customer_phone=+9665633&search_by_keyword=yes' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--header 'Accept-Language: ar' \
--header 'apikey: efe2db322a53' \
--header 'platform-key: 123456789' \
--header 'platform: web'Response Response Example
{
"status": true,
"message": "customer data",
"data": [
{
"id": 144,
"integration_id": null,
"integration_method": null,
"uuid": "468493ab-375b-4752-9ed4-889c108387c9",
"business_id": 259,
"related_business_id": null,
"first_name": "Mohamed Hashem",
"last_name": null,
"user_name": null,
"email": "mohamed@gmail.com",
"token": null,
"email_verified_at": null,
"password": "$2y$10$iWG8AQkeo/12N7vhscNGo.jNrMAmUpZMTLBfZHOLDaw1.qaF9ozYe",
"phone": "+966563339747",
"address1": null,
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": null,
"currency": null,
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": "reservation",
"reservation_cust_id": null,
"image": "",
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": null,
"kiosk_code": "1652",
"kiosk_token": null,
"user_kiosk_token": null,
"kiosk_code_verified_at": "2024-11-28 20:08:00",
"job": null,
"login_token": null,
"created_at": "2024-11-25T07:35:23.000000Z",
"updated_at": "2024-12-02T23:10:24.000000Z",
"deleted_at": null
},
{
"id": 329,
"integration_id": null,
"integration_method": null,
"uuid": "1a656ce0-5ade-4f44-b471-c41b3de71501",
"business_id": 259,
"related_business_id": null,
"first_name": "Sara Elkholy",
"last_name": null,
"user_name": null,
"email": "tester12345@gmail.com",
"token": null,
"email_verified_at": null,
"password": "$2y$10$aasYTbvlqiUdH3syNDu2T.vuRb6J0MNLvQaYysMjuBbek.6m1ebEe",
"phone": "+966563339748",
"address1": null,
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": null,
"currency": null,
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": "reservation",
"reservation_cust_id": null,
"image": "1001619713.jpg",
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": null,
"kiosk_code": "4472",
"kiosk_token": "123mm",
"user_kiosk_token": "syxvl368EWvwBA8KVfsTOtLJ67KsvVATkaqujGg4VEc1X6ey4bpVRIAl6G20",
"kiosk_code_verified_at": "2025-03-05 15:19:00",
"job": null,
"login_token": null,
"created_at": "2024-12-26T12:21:56.000000Z",
"updated_at": "2025-03-06T13:09:46.000000Z",
"deleted_at": null
},
{
"id": 2276,
"integration_id": null,
"integration_method": null,
"uuid": "42d940a6-f4af-4afb-b431-a9f3d580ec35",
"business_id": 259,
"related_business_id": null,
"first_name": "Abd Elrhman IOS",
"last_name": null,
"user_name": null,
"email": "abdoios@gmail.com",
"token": null,
"email_verified_at": null,
"password": "$2y$10$a4aIT7YaO912jneUDVI/xuHj9FtMt0ZPXqfg/J9PddMXCGc31fxB.",
"phone": "+966563339725",
"address1": null,
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": "",
"currency": null,
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": "reservation",
"reservation_cust_id": null,
"image": "",
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": 0,
"kiosk_code": null,
"kiosk_token": null,
"user_kiosk_token": null,
"kiosk_code_verified_at": null,
"job": "",
"login_token": null,
"created_at": "2025-01-26T20:20:41.000000Z",
"updated_at": "2025-01-26T20:20:41.000000Z",
"deleted_at": null
},
{
"id": 2535,
"integration_id": null,
"integration_method": null,
"uuid": "97ae544b-90a3-487a-9f76-e053d10acd55",
"business_id": 259,
"related_business_id": null,
"first_name": "اختبار عميل جديد 101",
"last_name": "",
"user_name": null,
"email": null,
"token": null,
"email_verified_at": null,
"password": null,
"phone": "+96656333974",
"address1": "",
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": null,
"currency": "126",
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": null,
"reservation_cust_id": null,
"image": null,
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": null,
"kiosk_code": null,
"kiosk_token": null,
"user_kiosk_token": null,
"kiosk_code_verified_at": null,
"job": null,
"login_token": null,
"created_at": "2025-02-25T16:41:41.000000Z",
"updated_at": "2025-02-25T16:41:41.000000Z",
"deleted_at": null
},
{
"id": 2553,
"integration_id": null,
"integration_method": null,
"uuid": "003eaf72-1be1-40a3-b282-2d854dcebd42",
"business_id": 259,
"related_business_id": null,
"first_name": "Yousssef",
"last_name": null,
"user_name": "Yousssef0702",
"email": "tidasos743@bankrau.com",
"token": "3271751",
"email_verified_at": null,
"password": "$2y$10$udN/ai9Ad4LopOI.893C9O6Qj.CA8AQ7EJSb4eNxxpGY3Bsfd2HAq",
"phone": "+966563333333",
"address1": null,
"longitude": null,
"latitude": null,
"address2": null,
"address_type": null,
"country_id": 0,
"city": null,
"district": null,
"state": null,
"postcode": null,
"vat_number": null,
"vat_number_check": "0",
"company_name": null,
"currency": null,
"business_identifier": null,
"billing_address": null,
"delivery_address": null,
"credit_limit": null,
"remember_token": null,
"user_type": "1",
"status": 1,
"started_balance": null,
"customer_type": "reservation",
"reservation_cust_id": null,
"image": "TEST.jpg",
"send_confirm_message": 1,
"bank_name": null,
"bank_account_number": null,
"bank_iban_number": null,
"commercial_register": null,
"user_cat_id": 0,
"kiosk_code": null,
"kiosk_token": null,
"user_kiosk_token": null,
"kiosk_code_verified_at": null,
"job": "",
"login_token": null,
"created_at": "2025-03-13T12:45:59.000000Z",
"updated_at": "2025-04-14T21:58:49.000000Z",
"deleted_at": null
}
]
}Request
Query Params
customer_phone
string
required
Example:
+9665633
search_by_keyword
string
required
Example:
yes
Header Params
secure-business-key
string
required
Example:
4765066450c0bd66325.48403130
Accept-Language
string
required
Example:
ar
apikey
string
required
Example:
efe2db322a53
platform-key
string
required
Example:
123456789
platform
string
required
Example:
web
Body Params multipart/form-data
object {0}