Skip to main content
POST
Search referenceable entities for mentions

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json

Request for the @-mention typeahead. Searches across configured entity types in parallel and returns the top N matches per type. Use the result fields to construct the inline <<ref:...>> token in your note's content and the matching NoteReference entry in references.

Request for the @-mention typeahead. Searches across configured entity types in parallel and returns the top N matches per type. Use the result fields to construct the inline <<ref:...>> token in your note's content and the matching NoteReference entry in references.

entity_types
string[]

Restrict to specific entity types. Empty array searches every searchable type. Pass e.g. ["equipment", "shipment"] to scope.

limit
integer<int64>

Per-type result cap. Defaults to 5.

query
string

Free-text query — typically the characters typed after @ in the editor (e.g. BNSF 543, acme, WB-1842).

Response

A successful response.

results
object[]

Top matches across all (or the requested) entity types. Per-type results are flattened and sorted by score; clients typically re-group by entity_type for display.