Skip to main content
POST
Search timeline

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of search_timeline.

filter
object
required

Exactly one of person_sid and conversation_sid; both or neither is a 422.

page_size
integer

1..200, default 50: the merged page. Each source contributes up to that many rows, and a page may run shorter when a source holds rows back behind the watermark; has_more is the only end signal.

Required range: 1 <= x <= 200
cursor
string | null

The composite cursor from the previous page's pagination.next_cursor (opaque: every source's position). Omit it for the newest page.

Maximum string length: 4096

Response

search success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
search
items
object[]
required
pagination
object
required
applied_filters
object
required
includes
string[]
required
meta
object
required
counts
object