Find companies by identity
POST
/api/v1/companies/searchSearch company names, websites or registration numbers before selecting a record to enrich.
Inputs. Supply name, website_url or registration_number; country_code is optional. page: 1–10, limit: 1–5.
curl --fail-with-body "$TARGETWISE_BASE_URL/companies/search" \
-H "Authorization: Bearer $TARGETWISE_API_KEY" \
-H "Content-Type: application/json" \
--data '{"name":"Tesco","country_code":"GB","limit":1}'Parameters and exact JSON schemas
Use the identifier rules above alongside this field list. The schemas below include required combinations, defaults and allowed values.
| Parameter | Type | Default / limits |
|---|---|---|
name | string | See schema |
website_url | string | See schema |
registration_number | string | See schema |
country_code | string | See schema |
page | integer | Min: 1 · Max: 10 |
limit | integer | Min: 1 · Max: 5 |
{
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"website_url"
]
},
{
"required": [
"registration_number"
]
}
],
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 200
},
"website_url": {
"type": "string",
"format": "uri",
"minLength": 8,
"maxLength": 500,
"pattern": "^https?://"
},
"registration_number": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"country_code": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 5
}
}
}{
"type": "object",
"additionalProperties": false,
"required": [
"object",
"operation",
"request_id",
"status",
"data",
"pagination",
"grounding"
],
"properties": {
"object": {
"type": "string",
"const": "prospecting_result"
},
"operation": {
"type": "string",
"const": "company_search"
},
"request_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"matched",
"not_found"
]
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"company_id": {
"type": "string"
},
"company_name": {
"type": "string"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"page",
"per_page",
"total_results",
"total_pages",
"has_more"
],
"properties": {
"page": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 25
},
"total_results": {
"type": "integer",
"minimum": 0
},
"total_pages": {
"type": "integer",
"minimum": 0
},
"has_more": {
"type": "boolean"
}
}
},
"grounding": {
"type": "object",
"additionalProperties": false,
"required": [
"retrieved_at",
"source_provenance"
],
"properties": {
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_provenance": {
"type": "string",
"const": "not_available"
}
}
}
}
}