List companies
Companies with filters.
GET/api/v1/companies
Parameters
Query
| Name | In | Description |
|---|---|---|
q | query | Search text. |
industry | query | Industry. |
country | query | Country. |
list_id | query | Only companies with a lead in this list. |
enrichment | query | enriched or not_enriched. |
limit | query, integer | Rows. |
offset | query, integer | Offset. |
Example
curl
curl -X GET "https://crm.ashwanth.dev/api/v1/companies" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine companies listResponse
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.
Industry.
Country.
Only companies with a lead in this list.
enriched or not_enriched.
Rows.
Offset.
Request
GET /api/v1/companies