List Companies

Returns a list of matching companies from the Intellizence database

GET /api/v1/companies HTTP/1.1

Parameters

Param
Mandatory
Description

name

N

Partial name of the Company, minimum 3 chars required.

domain

N

Partial Domain Name without http(s), minimum 6 chars required.

Note : You have to pass either Company Name or Domain Name.

Response Body

{
    "status":"status_code",
    "message":"status_message",
    "companies": [
        {
            "id": "intellizence_company_id_1",
            "name": "company_name_1",
            "domain": "company_domain_1"
        },
        {
            "id": "intellizence_company_id_2",
            "name": "company_name_2",
            "domain": "company_domain_2"
        }
    ]
}
Status code
Description

200

Success

201

Input minimum 3 chars of Company Name or minimum 6 chars of Domain Name

202

Minimum 3 chars of Company Name required

203

Minimum 6 chars of Domain Name required

Last updated