list_companies

​

When to use

• “What companies do we have?”
• “List companies added this month.”
• “How many distinct companies signed up last week?”

​

Parameters

​

Example response

{
  "data": [
    { "id": 1041, "domain": "acme.com", "external_id": null },
    { "id": 1040, "domain": "globex.com", "external_id": null },
    { "id": 1039, "domain": null, "external_id": "acct_8f3k2" }
  ],
  "next_cursor": "eyJpZCI6MTAzOX0",
  "prev_cursor": null,
  "per_page": 200
}

​

Caveats

• Companies don’t have custom fields — they’re derived from contact email domain or external ID. There’s no custom_field_filters parameter on this tool today.
• domain can be null — for a company identified only by a customer-supplied external_id rather than an email domain. Refer to those companies by their external_id, or by ID if that’s null too.
• external_id can be null — for a company identified only by an email domain. It’s null unless the customer explicitly set one via Update Company or events carrying company_external_id.
• name is not included in the list view — use get_company to retrieve it.
• Order is newest first by id descending.