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· optionalstring
Search company records.
filter· optionalFilterDescriptor
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· optionalarray|object
Legacy company filter format. Do not send together with filter.
sort· optionalstring
Company field to sort by; default name.
order· optionalstring
asc or desc; default asc.
limit· optionalinteger
Page size, 1–500; default 100.
offset· optionalinteger
Number of results to skip; default 0.
qualified_only· optionalboolean
Only return qualified companies; default false.
include_memory· optionalboolean
Include unpromoted internal company memory; default false.
owner_id· optionalstring
source_table_id· optionalstring
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.
| Name | Type | Description |
|---|---|---|
| search | string | Search company records. |
| filter | 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 | array|object | Legacy company filter format. Do not send together with filter. |
| sort | string | Company field to sort by; default name. |
| order | string | asc or desc; default asc. |
| limit | integer | Page size, 1–500; default 100. |
| offset | integer | Number of results to skip; default 0. |
| qualified_only | boolean | Only return qualified companies; default false. |
| include_memory | boolean | Include unpromoted internal company memory; default false. |
| owner_id | string | - |
| source_table_id | 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
| Status | Meaning |
|---|---|
| 400 | Organization context missing or company query contract rejected. |
| 401 | Missing or invalid authentication. |
| 403 | Developer key lacks companies:read. |
| 422 | Body shape, field, filter, sort, or pagination value is invalid. |
