Skip to main content
GET
Search a conversation route's messages

Authorizations

x-api-key
string
header
required

Path Parameters

route_name
string
required

Query Parameters

page
integer
default:1

1-based page number, newest activity first.

Required range: 1 <= x <= 1000000
pageSize
integer
default:50

Items per page. A larger value is capped to 200, never refused.

Required range: x >= 1
q
string
required

The text to search the route's records for.

Minimum string length: 1
Pattern: \S

Response

Success.

data
MessageSearchEnvelope · object
required

A page of a route's message-search matches (admin-only, so always full records).