Skip to main content

Query companies

Filter and page through companies in your organization.

POST/api/companies/query
HTTP referenceScope companies:readUpdated September 28, 2026

This page documents the canonical HTTP contract for this endpoint.

This endpoint uses the same crm.query_companies operation contract as the company list operation. The body rejects unknown fields and cannot combine filter with legacy filters. Filter fields and operators are validated against the company workspace catalog. Results are organization-scoped. By default unpromoted company memory is excluded; set include_memory=true to include it in an ordinary organization query. qualified_only defaults to false. When source_table_id is provided, results are table-membership scoped and free-text search is rejected; that branch returns promoted companies. The response may include additional company fields beyond this abbreviated example.

Body parameters

  • search · optional

    string

    Search company records.

  • filter · optional

    FilterDescriptor

    Structured filter tree. A rule has kind=rule, field, operator, and value or values; a group has kind=group, logic=and|or|not, and children.

  • filters · optional

    array|object

    Legacy company filter format. Do not send together with filter.

  • sort · optional

    string

    Company field to sort by; default name.

  • order · optional

    string

    asc or desc; default asc.

  • limit · optional

    integer

    Page size, 1–500; default 100.

  • offset · optional

    integer

    Number of results to skip; default 0.

  • qualified_only · optional

    boolean

    Only return qualified companies; default false.

  • include_memory · optional

    boolean

    Include unpromoted internal company memory; default false.

  • owner_id · optional

    string

  • source_table_id · optional

    string

    Restrict to promoted company records whose research_sources include this table ID. This uses companies:read; it does not require a separate tables:read scope.

Errors

StatusMeaning
400Organization context missing or company query contract rejected.
401Missing or invalid authentication.
403Developer key lacks companies:read.
422Body shape, field, filter, sort, or pagination value is invalid.

Docs