Companies
Count companies matching filters
Return the exact number of companies matching the given filters. Accepts the same request body as listCompanies (pagination and sort are ignored). Use this when you only need a total; to get the matching companies themselves, send the same request body to listCompanies.
x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/companies/count" \ -H "Content-Type: application/json" \ -d '{}'{
"lenderNormalizations": [
{
"aliasCount": 0,
"displayName": "string",
"id": "string",
"matchedVia": "id",
"original": "string",
"totalDocuments": 0
}
],
"locationNormalizations": [
{
"candidates": [
"string"
],
"confidence": "normalized",
"displayName": "Saint Louis, MO",
"field": "city",
"id": "city_mo_saint-louis",
"normalized": "Saint Louis",
"original": "St. Louis",
"variants": [
"string"
]
}
],
"total": 48213
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"limit": 0,
"size": 0
}