Skip to main content
GET
Search conversations

Request contract

  • Method and path: GET /apis/v1/social/inbox/conversations/search
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/social/inbox/conversations/search
  • query: query; required
  • direction: query; optional
  • profileId: query; optional
  • platform: query; optional
  • accountId: query; optional
  • limit: query; optional
  • cursor: query; optional
  • Runtime facts: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

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

Query Parameters

query
string
required

Text to search for, in message content and in the contact's name, username, or phone number

Required string length: 2 - 200
direction
enum<string>

Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.

Available options:
incoming,
outgoing
profileId
string

One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.

Pattern: ^prf_[0-9A-Za-z]{22}$
platform
enum<string>

Filter by platform (searchable platforms only)

Available options:
facebook,
instagram,
telegram,
whatsapp,
sms,
rcs,
slack,
imessage
accountId
string

One of your social accounts (acc_...).

Pattern: ^acc_[0-9A-Za-z]{22}$
limit
integer
default:20

Maximum number of conversations to return

Required range: 1 <= x <= 50
cursor
string

Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.

Response

Conversations containing the query, most recent match first

data
object[]
meta
object
pagination
object