Customer Search+Enquiry

Developing

POST

https://api.gofive.co.thv1/customers/search

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Example

{
    "customerTypes": [
        "eiusmod",
        "laboris magna ea et"
    ],
    "keyword": "pariatur incididunt reprehenderit",
    "searchIn": [
        "non deserunt culpa",
        "dolor adipisicing in",
        "magna"
    ],
    "isExactMatch": false,
    "filters": {
        "states": [
            -70366090
        ],
        "actionStates": [
            -28878246
        ],
        "statuses": [
            -26955809,
            -92201214
        ],
        "ownerTeams": [
            "ipsum"
        ],
        "owners": [
            "cillum ut"
        ],
        "primaryOwner": "in minim veniam",
        "topicInterests": [
            94452350,
            -32643672
        ],
        "classifications": [
            -61727399,
            19901168,
            81576014
        ],
        "groups": [
            6753957
        ],
        "probabilities": [
            -45730863,
            -23669864,
            67636179
        ],
        "tags": [
            "currus",
            "angelus",
            "laborum"
        ],
        "branchCodes": [
            "40",
            "2"
        ],
        "sources": [
            "dolore deserunt est aliquip",
            "ipsum nisi",
            "ad ea"
        ]
    },
    "geoSearch": {
        "latitude": -35.5468,
        "longitude": 67.0671,
        "distanceLimit": 26193529.963385835
    },
    "skip": -23337457,
    "take": -32307802,
    "orderBy": "incididunt nisi magna",
    "displayColumns": [
        "ut quis anim ex",
        "labore",
        "sit deserunt"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.gofive.co.thv1/customers/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerTypes": [
        "eiusmod",
        "laboris magna ea et"
    ],
    "keyword": "pariatur incididunt reprehenderit",
    "searchIn": [
        "non deserunt culpa",
        "dolor adipisicing in",
        "magna"
    ],
    "isExactMatch": false,
    "filters": {
        "states": [
            -70366090
        ],
        "actionStates": [
            -28878246
        ],
        "statuses": [
            -26955809,
            -92201214
        ],
        "ownerTeams": [
            "ipsum"
        ],
        "owners": [
            "cillum ut"
        ],
        "primaryOwner": "in minim veniam",
        "topicInterests": [
            94452350,
            -32643672
        ],
        "classifications": [
            -61727399,
            19901168,
            81576014
        ],
        "groups": [
            6753957
        ],
        "probabilities": [
            -45730863,
            -23669864,
            67636179
        ],
        "tags": [
            "currus",
            "angelus",
            "laborum"
        ],
        "branchCodes": [
            "40",
            "2"
        ],
        "sources": [
            "dolore deserunt est aliquip",
            "ipsum nisi",
            "ad ea"
        ]
    },
    "geoSearch": {
        "latitude": -35.5468,
        "longitude": 67.0671,
        "distanceLimit": 26193529.963385835
    },
    "skip": -23337457,
    "take": -32307802,
    "orderBy": "incididunt nisi magna",
    "displayColumns": [
        "ut quis anim ex",
        "labore",
        "sit deserunt"
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": {
        "code": "1000",
        "description": "success"
    },
    "data": [
        {
            "customerId": 12345,
            "customerCode": "CORP-31",
            "customerName": "Roy Franecki, DVM",
            "customer2ndName": "Paw Health Veterinary Center",
            "customerAliases": [
                "PH Veterinary",
                "Roy's Clinic"
            ],
            "customerPicture": "https://images.unsplash.com/...",
            "customerTaxNo": "0105564000123",
            "customerType": 102,
            "customerStatus": 1,
            "leadStatus": 5,
            "uniqueName": "string",
            "customerNote": "ลูกค้าพรีเมียม ตอบรับเร็ว...",
            "categorization": {
                "groupName": "Premium Partners",
                "classificationName": "Gold Tier",
                "sourceOfLead": "Referral by Dr. Brian",
                "currentStateId": 1,
                "currentStateName": "Prospect",
                "customerTags": [
                    "VIP",
                    "VIP-High"
                ],
                "customFields": [
                    "Active Contract"
                ]
            },
            "contactInfo": {
                "customerPhone": "02-123-4567",
                "customerMobile": "081-926-8635",
                "customerEmail": "[email protected]",
                "socialAccount": {
                    "facebook": "fb.com/pawhealth_clinic"
                }
            },
            "address": {
                "addressId": 90,
                "branchCode": "HQ-01",
                "locationName": "Headquarters",
                "locationAddress": "1405 Ashly Fort Street",
                "secondaryAddress": "Suite 278",
                "locationType": 1,
                "latitude": "13.7563",
                "longitude": "100.5018",
                "subdistrict": "ปทุมวัน",
                "subdistrictEN": "Pathum Wan",
                "district": "กรุงเทพมหานคร",
                "districtEN": "Bangkok",
                "province": "กรุงเทพมหานคร",
                "provinceEN": "Bangkok",
                "zipCode": "10330"
            },
            "owners": [
                {
                    "id": "EMP001",
                    "title": "John Doe",
                    "group": "Sales Team A",
                    "teamId": 1,
                    "pictureUrl": "string",
                    "isPrimaryOwner": true,
                }
            ],
            "contacts": [
                {
                    "contactName": "Brandi Beatty",
                    "contactPicture": "https://i.pravatar.cc/400?img=32",
                    "contactPhone": "02-123-4568",
                    "contactMobile": "065-927-1579",
                    "contactEmail": "[email protected]",
                    "contactSocialAccount": {
                        "facebook": "brandi.beatty.official"
                    },
                    "contactPosition": "Operations Manager",
                    "contactBirthdate": "1990-06-19",
                    "contactNote": "ตัดสินใจเรื่องการสั่งซื้ออุปกรณ์ทั่วไป",
                    "contactStatus": true,
                    "tags": [
                        "Main-Contact",
                        "Purchasing"
                    ]
                }
            ],
            "topicInterests": [
                {
                    "topicId": 1,
                    "topicName": "Animal Vaccines"
                }
            ],
            "stats": {
                "activityStats": [
                    {
                        "type": "0",
                        "count": 5
                    }
                ],
                "onGoingStats": [
                    {
                        "type": "0",
                        "count": 2
                    }
                ],
                "thisYearStats": [
                    {
                        "type": "0",
                        "count": 10
                    }
                ],
                "markDealStage": {
                    "current": 2,
                    "max": 5
                },
                "dealStage": 1,
                "dealName": "Negotiation",
                "dealPotential": 500000.0
            },
            "audit": {
                "latestUpdateByUser": "UserA",
                "latestUpdateType": "Edit Profile",
                "dateLatestUpdated": "2022-11-21T15:51:26+0700",
                "dateAcquired": 2022,
                "dateFollowUp": "2022-12-01"
            }
        }
    ]
}

🟠401User authentication required V2.

Modified at 2026-02-20 08:48:32

Get Customer By TaxID

Add Case