Skip to main content
search

Company Search

Operator-level, company-wide semantic ranking signal over machines and metadata.

GET
/api/records/{company_name}/company/search

Available to every role in the company (including operators) — the same gate as the machine list endpoint (MACHINE_TEMPLATE_READ). Unlike the global search, and like the diagnostics search, it returns bare (entity_type, entity_id, score) hits with no display name or navigation context: consumers already hold their own machine/metadata lists locally and map ids onto them.

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

company_namestringrequired
qstringqueryrequired

Free-text search query

Required string length: 1 - 500
limitintegerquerydefault:20
Required range: 1 <= x <= 50
entity_typeenum<string>[]queryrequired

Restrict to these entity types (required — no default). Allowed: ['machine', 'metadata'].

Response

application/json

Successful Response

hitsobject[]required