Customer Search - Gofive OpenAPI

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Example

{
    "customerType": 11300,
    "keyword": "บริษัท เทคโนโลยี",
    "customerTaxNo": "0105555555555",
    "searchIn": [
        "customerName",
        "contactName",
        "customerCode",
        "customerTaxNo",
        "customerEmail",
        "contactEmail",
        "customerMobile",
        "contactMobile",
        "customerPhone",
        "contactPhone"
    ],
    "isExactMatch": false,
    "skip": 0,
    "take": 20,
    "orderBy": "dateLatestUpdated desc",
    "filters": {
        "states": 200001,
        "actionStates": 1,
        "ownerTypes": 2,
        "ownerTeams": 15,
        "owners": [
            "USR-001",
            "USR-002"
        ],
        "primaryOwner": "USR-001",
        "topicInterests": [
            1,
            2,
            5
        ],
        "classifications": [
            1001,
            1002
        ],
        "groups": [
            50,
            51
        ],
        "statuses": [
            true
        ],
        "probabilities": [
            50,
            80,
            100
        ],
        "tags": [
            "VIP",
            "Bangkok"
        ],
        "sources": [
            "1",
            "3"
        ]
    },
    "geoSearch": {
        "latitude": 13.736717,
        "longitude": 100.523186,
        "distanceLimit": 5000.5
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.gofive.co.th/v2/customers/enquiry' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerType": 11300,
    "keyword": "บริษัท เทคโนโลยี",
    "customerTaxNo": "0105555555555",
    "searchIn": [
        "customerName",
        "contactName",
        "customerCode",
        "customerTaxNo",
        "customerEmail",
        "contactEmail",
        "customerMobile",
        "contactMobile",
        "customerPhone",
        "contactPhone"
    ],
    "isExactMatch": false,
    "skip": 0,
    "take": 20,
    "orderBy": "dateLatestUpdated desc",
    "filters": {
        "states": 200001,
        "actionStates": 1,
        "ownerTypes": 2,
        "ownerTeams": 15,
        "owners": [
            "USR-001",
            "USR-002"
        ],
        "primaryOwner": "USR-001",
        "topicInterests": [
            1,
            2,
            5
        ],
        "classifications": [
            1001,
            1002
        ],
        "groups": [
            50,
            51
        ],
        "statuses": [
            true
        ],
        "probabilities": [
            50,
            80,
            100
        ],
        "tags": [
            "VIP",
            "Bangkok"
        ],
        "sources": [
            "1",
            "3"
        ]
    },
    "geoSearch": {
        "latitude": 13.736717,
        "longitude": 100.523186,
        "distanceLimit": 5000.5
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": {
        "code": "200",
        "description": "success"
    },
    "data": [
        {
            "customerId": 98765,
            "customerCode": "CUST-2023-001",
            "customerName": "บริษัท เทคโนโลยี จำกัด (มหาชน)",
            "customer2ndName": "Technology Public Co., Ltd.",
            "customerAliases": [
                "เทคโน",
                "Tech PC"
            ],
            "customerPicture": "https://storage.venio.io/images/customers/98765.png",
            "customerTaxNo": "0105555555555",
            "customerType": 11300,
            "customerStatus": 1,
            "leadStatus": null,
            "uniqueName": "บริษัท เทคโนโลยี จำกัด (มหาชน)-0105555555555",
            "customerNote": "ลูกค้ารายใหญ่ ต้องการระบบ ERP",
            "categorization": {
                "groupName": "กลุ่มอุตสาหกรรมไอที",
                "classificationName": "Enterprise",
                "sourceOfLead": "Website Contact Form",
                "currentStateId": 200001,
                "currentStateName": "ติดต่อแล้ว (Contacted)",
                "customerTags": [
                    "VIP",
                    "Bangkok"
                ],
                "customFields": [
                    "งบประมาณ: 1,000,000"
                ]
            },
            "contactInfo": {
                "customerPhone": "02-123-4567",
                "customerMobile": "081-123-4567",
                "customerEmail": "[email protected]",
                "socialAccount": {
                    "facebook": "technology.th"
                }
            },
            "address": {
                "addressId": 1102,
                "branchCode": "00000",
                "locationName": "สำนักงานใหญ่",
                "locationAddress": "99/9 อาคารซอฟต์แวร์ปาร์ค ชั้น 10 ถนนแจ้งวัฒนะ",
                "secondaryAddress": "ห้อง 1001",
                "locationType": 1,
                "latitude": "13.901234",
                "longitude": "100.523456",
                "subdistrict": "คลองเกลือ",
                "district": "ปากเกร็ด",
                "province": "นนทบุรี",
                "zipCode": "11120",
                "subdistrictEN": "Khlong Kluea",
                "districtEN": "Pak Kret",
                "provinceEN": "Nonthaburi"
            },
            "owners": [
                {
                    "id": "USR-001",
                    "title": "นาย สมเกียรติ ยอดขาย",
                    "group": "Enterprise Sales Team",
                    "teamId": 15,
                    "pictureUrl": "https://storage.venio.io/images/users/usr-001.png",
                    "isPrimaryOwner": true
                },
                {
                    "id": "USR-002",
                    "title": "นางสาว ใจดี บริการ",
                    "group": "Enterprise Support Team",
                    "teamId": 16,
                    "pictureUrl": "https://storage.venio.io/images/users/usr-002.png",
                    "isPrimaryOwner": false
                }
            ],
            "contacts": [
                {
                    "contactName": "คุณสมคิด ตัดสินใจ",
                    "contactPicture": null,
                    "contactPhone": "02-123-4568",
                    "contactMobile": "089-999-8888",
                    "contactEmail": "[email protected]",
                    "contactSocialAccount": {
                        "facebook": "somkid.ceo"
                    },
                    "contactPosition": "Chief Executive Officer (CEO)",
                    "contactBirthdate": "1975-05-15T00:00:00Z",
                    "contactNote": "ชอบตีกอล์ฟ สะดวกคุยช่วงบ่าย",
                    "contactStatus": true,
                    "tags": [
                        "Decision Maker",
                        "C-Level"
                    ]
                }
            ],
            "topicInterests": [
                {
                    "topicId": 1,
                    "topicName": "ERP Implementation"
                },
                {
                    "topicId": 5,
                    "topicName": "Cloud Hosting"
                }
            ],
            "stats": {
                "activityStats": [
                    {
                        "type": "call",
                        "count": 12
                    },
                    {
                        "type": "meeting",
                        "count": 3
                    }
                ],
                "onGoingStats": [
                    {
                        "type": "deal",
                        "count": 1
                    }
                ],
                "thisYearStats": [
                    {
                        "type": "won",
                        "count": 1
                    }
                ],
                "markDealStage": {
                    "current": 4,
                    "max": 6
                },
                "dealStage": 4,
                "dealName": "Project ERP Implementation Phase 1",
                "dealPotential": 1500000.00
            },
            "audit": {
                "latestUpdateByUser": "USR-001",
                "latestUpdateType": "Update Customer Address",
                "dateLatestUpdated": "2023-11-20T14:30:00Z",
                "dateAcquired": 1672531200,
                "dateFollowUp": "2023-11-25T10:00:00Z"
            }
        }
    ]
}

🟠401User authentication required V2.