GET /v1/lookup/category

HTTP Method: GET

Path: /v1/lookup/category

Authentication: API Key required

Note: This method is not available to API users on our Starter Plan. Please contact us if you want access to this method

Description: Find categories that match a given string. The response will contain all categories that the given string is associated with. For example, the sting "central heating" matches the category Plumbers and also the category Central Heating Installation and Servicing

Parameters:

Sample Response:

{
    "success": true,
    "msg": "Success - Category found",
    "data": {
        "total_rows": 3,
        "rows": [
            {
                "id": "365",
                "order": [
                    2.7748520374298096,
                    14
                ],
                "fields": {},
                "doc": {
                    "_id": "365",
                    "_rev": "34-8aaf185aab2d2895d9003a526f984763",
                    "name": {
                        "en": "Plumbing and Heating Merchants"
                    },
                    "mappings": [
                        {
                            "type": "legacy_ci",
                            "id": "1326",
                            "name": "Plumbers Merchants"
                        },
                        {
                            "type": "legacy_ci",
                            "id": "6716",
                            "name": "China Plumbing Fixture Manufacturers"
                        },
                        {
                            "type": "bill_moss",
                            "id": "693",
                            "name": "Plumbing Supplies"
                        },
                        {
                            "type": "goat",
                            "id": "365",
                            "name": "Plumbers Merchants"
                        }
                    ],
                    "synonyms": {
                        "en": [
                            "Fittings wholesaler",
                            "Fittings wholesaling",
                            "plumber supplier",
                            "plumber suppliers",
                            "plumber supplies",
                            "plumber supply",
                            "plumber supplying",
                            "Plumber's fittings wholesaler",
                            "Plumber's fittings wholesaling",
                            "plumbers merchant",
                            "plumbers supply",
                            "plumbing supplier",
                            "plumbing suppliers",
                            "plumbing supplies",
                            "plumbing supply",
                            "plumber",
                            "plumbers merchants",
                            "bathroom",
                            "boiler",
                            "heating supplies",
                            "boiler repair",
                            "heat",
                            "bathroom showroom",
                            "boiler installations",
                            "plumbing and heating",
                            "radiators",
                            "showers",
                            "central heating",
                            "bathroom suites"
                        ]
                    }
                }
            },
            {
                "id": "364",
                "order": [
                    0.5107113122940063,
                    96
                ],
                "fields": {},
                "doc": {
                    "_id": "364",
                    "_rev": "38-7f1970c62aa3cb53ed16593661bc9a9e",
                    "name": {
                        "en": "Plumbers"
                    },
                    "mappings": [
                        {
                            "type": "sic_2007",
                            "id": "43220",
                            "name": "Plumbing, heat and air-conditioning installation"
                        },
                        {
                            "type": "legacy_ci",
                            "id": "1325",
                            "name": "Plumbers"
                        },
                        {
                            "type": "goat",
                            "id": "364",
                            "name": "Plumbers"
                        },
                        {
                            "type": "jpress",
                            "id": "1000441",
                            "name": "Plumbing & Heating Services"
                        }
                    ],
                    "synonyms": {
                        "en": [
                            "heating",
                            "heating contractor",
                            "Plumber",
                            "plumber",
                            "plumbing",
                            "Plumbing",
                            "plumbing contractor",
                            "central heating",
                            "boiler installations",
                            "boiler replacement",
                            "central heating systems",
                            "corgi plumber",
                            "boiler repair",
                            "bathroom installation",
                            "emergency plumbers",
                            "bathroom",
                            "bathroom fitter",
                            "boiler",
                            "central heating installation",
                            "boiler servicing",
                            "heat",
                            "power flushing",
                            "boiler service",
                            "gas engineers",
                            "plumbing and heating",
                            "blocked drains",
                            "plumbing heating",
                            "plumbing services",
                            "drainage",
                            "local plumber",
                            "leaks",
                            "burst pipes"
                        ]
                    }
                }
            },
            {
                "id": "1405",
                "order": [
                    0.1884690821170807,
                    65
                ],
                "fields": {},
                "doc": {
                    "_id": "1405",
                    "_rev": "26-abffd46f383f1347c60f8df24af6492e",
                    "name": {
                        "en": "Drain and Sewer Cleaning and Maintenance"
                    },
                    "mappings": [
                        {
                            "type": "legacy_ci",
                            "id": "559",
                            "name": "Drain Unblocking Equipment"
                        },
                        {
                            "type": "bill_moss",
                            "id": "286",
                            "name": "Drain & Sewer Cleaning Equipment & Supplies"
                        },
                        {
                            "type": "bill_moss",
                            "id": "287",
                            "name": "Drain/Sewer Cleaning"
                        },
                        {
                            "type": "legacy_ci",
                            "id": "560",
                            "name": "Drains and Sewers"
                        },
                        {
                            "type": "goat",
                            "id": "1407",
                            "name": "Drain and Sewar Services"
                        },
                        {
                            "type": "goat",
                            "id": "1405",
                            "name": "Drain "
                        },
                        {
                            "type": "jpress",
                            "id": "1000426",
                            "name": "Drain & Pipe Cleaners"
                        }
                    ],
                    "synonyms": {
                        "en": [
                            "drain unblocking equipment",
                            "Drain and Sewer Cleaning and Maintenance",
                            "Drain",
                            "drain cleaning",
                            "drain clearing",
                            "drain maintenance",
                            "drain unblocking",
                            "sewer",
                            "sewer clearing",
                            "sewer maintenance",
                            "sewer unblocking",
                            "drains and sewers",
                            "plumber",
                            "blocked drains",
                            "all work guaranteed",
                            "Rapid Response To All Areas",
                            "no call out charge",
                            "24hr Emergency Plumbing Service",
                            "drainage",
                            "drain",
                            "cctv surveys",
                            "unblock drain",
                            "drain repairs",
                            "drain clearance",
                            "cctv drain surveys",
                            "high pressure water jetting",
                            "emergency plumbers",
                            "blocked manhole"
                        ]
                    }
                }
            }
        ],
        "from_cache": true
    }
}