Sales Engine
API documentation
CompaniesOperation companies.summary

Get company counts

Tile numbers for the companies the filters show (total, top industry, industries, countries, average ICP score), plus every industry and country to filter by.

GET/api/v1/companies/summary
Scope read: Read anything in the workspace.

Parameters

Query

NameInDescription
qquerySearch text.
industryqueryOne industry.
countryqueryOne country.
enrichmentqueryenriched or not_enriched. One of enriched, not_enriched.
list_idqueryOnly companies behind this lead list.

Example

curl
curl -X GET "https://crm.ashwanth.dev/api/v1/companies/summary" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine companies summary

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Query
Search text.
One industry.
One country.
enriched or not_enriched.
Only companies behind this lead list.
Request
GET /api/v1/companies/summary

Also in Companies