Skip to main content
POST
Search notes (full-text)

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
entity_type
string

Restrict results to one entity type (e.g. shipment). Empty string searches all entity types for the carrier.

page_size
integer<int32>

Page size for cursor pagination. Defaults to 20 if unset or zero.

page_token
string

Opaque cursor from a previous response's next_page_token.

query
string

Free-text query. Tokenized via Postgres plainto_tsquery('english', ...). Entity reference chips and #group(content) hashtag syntax are normalized server-side so chip text and automation-written hashtag content are searchable as plain words. Empty query returns an empty result set.

Response

A successful response.

next_page_token
string

Opaque cursor for the next page. Empty when there are no more results. Pass back as page_token on the next request.

results
object[]

Matching notes ordered by score descending.

total_count
integer<int32>

Total matching notes across all pages — useful for displaying "showing X of Y results" labels.