Search conversations
curl --request GET \
--url https://api.aisa.one/apis/v1/social/inbox/conversations/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/social/inbox/conversations/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/social/inbox/conversations/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/social/inbox/conversations/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/social/inbox/conversations/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/social/inbox/conversations/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/social/inbox/conversations/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"conversation": {
"accountId": "<string>",
"businessScopedUserId": "<string>",
"id": "<string>",
"lastMessage": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z",
"participantName": "<string>",
"participantPicture": "<string>",
"participantUsername": "<string>",
"platform": "<string>",
"status": "active",
"whatsappUsername": "<string>"
},
"matchCount": 123,
"matches": [
{
"direction": "incoming",
"id": "<string>",
"text": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
],
"meta": {
"accountsFailed": 123,
"accountsQueried": 123,
"accountsSkipped": [
{
"accountId": "<string>",
"platform": "<string>"
}
],
"failedAccounts": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"error": "<string>",
"platform": "<string>"
}
],
"lastUpdated": "2023-11-07T05:31:56Z"
},
"pagination": {
"hasMore": true,
"nextCursor": "<string>"
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "never",
"retryable": true,
"type": "<string>"
}
}AIsa Social
Search conversations
Inbox. Read only; needs social:read. Ids are yours: accounts acc_..., profiles prf_..., posts pst_...; every other object id is checked against your accounts before the call. Without profileId or accountId it reads your default profile. On a profile with an X account, pass accountId or a platform other than twitter: X bills each read.
Search your conversations two ways at once, and get back the matching conversations, most-recent match first.
### Message text
Matches words inside message bodies. Case-insensitive and accent-insensitive, exact tokens only (no substrings, no stemming). Each hit carries up to 3 most-recent matching messages.
With direction=outgoing you can collect examples of how you write to customers, for example to teach an AI agent your tone of voice.
### Contact identity
Matches the participant's name, username, or phone number as a case-insensitive substring. These hits have matchCount 0 and an empty matches array.
A conversation that matches both ways is returned once, carrying its message matches.
### Searchable platforms
Only platforms whose messages are stored by AIsa are searchable: WhatsApp, SMS, Telegram, Facebook, Instagram, X and Reddit.
Bluesky conversations are fetched live from the platform and cannot be searched; those accounts are listed in meta.accountsSkipped.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
GET
https://api.aisa.one
/
apis
/
v1
/
social
/
inbox
/
conversations
/
search
Search conversations
curl --request GET \
--url https://api.aisa.one/apis/v1/social/inbox/conversations/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/social/inbox/conversations/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aisa.one/apis/v1/social/inbox/conversations/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/social/inbox/conversations/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/social/inbox/conversations/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/social/inbox/conversations/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/social/inbox/conversations/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"conversation": {
"accountId": "<string>",
"businessScopedUserId": "<string>",
"id": "<string>",
"lastMessage": "<string>",
"lastMessageAt": "2023-11-07T05:31:56Z",
"participantName": "<string>",
"participantPicture": "<string>",
"participantUsername": "<string>",
"platform": "<string>",
"status": "active",
"whatsappUsername": "<string>"
},
"matchCount": 123,
"matches": [
{
"direction": "incoming",
"id": "<string>",
"text": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
],
"meta": {
"accountsFailed": 123,
"accountsQueried": 123,
"accountsSkipped": [
{
"accountId": "<string>",
"platform": "<string>"
}
],
"failedAccounts": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"error": "<string>",
"platform": "<string>"
}
],
"lastUpdated": "2023-11-07T05:31:56Z"
},
"pagination": {
"hasMore": true,
"nextCursor": "<string>"
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "never",
"retryable": true,
"type": "<string>"
}
}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
{
"operationId": "get_aisa_social_apis_v1_social_inbox_conversation_a94af9",
"method": "GET",
"path": "/apis/v1/social/inbox/conversations/search",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Text to search for, in message content and in the contact's name, username, or phone number",
"in": "query",
"name": "query",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 2,
"type": "string"
}
},
{
"description": "Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.",
"in": "query",
"name": "direction",
"required": false,
"schema": {
"enum": [
"incoming",
"outgoing"
],
"type": "string"
}
},
{
"description": "One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.",
"in": "query",
"name": "profileId",
"required": false,
"schema": {
"pattern": "^prf_[0-9A-Za-z]{22}$",
"type": "string"
}
},
{
"description": "Filter by platform (searchable platforms only)",
"in": "query",
"name": "platform",
"required": false,
"schema": {
"enum": [
"facebook",
"instagram",
"telegram",
"whatsapp",
"sms",
"rcs",
"slack",
"imessage"
],
"type": "string"
}
},
{
"description": "One of your social accounts (acc_...).",
"in": "query",
"name": "accountId",
"required": false,
"schema": {
"pattern": "^acc_[0-9A-Za-z]{22}$",
"type": "string"
}
},
{
"description": "Maximum number of conversations to return",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "Included with your connected social accounts: AIsa does not charge per call.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Text to search for, in message content and in the contact's name, username, or phone number
Required string length:
2 - 200Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.
Available options:
incoming, outgoing One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.
Pattern:
^prf_[0-9A-Za-z]{22}$Filter by platform (searchable platforms only)
Available options:
facebook, instagram, telegram, whatsapp, sms, rcs, slack, imessage One of your social accounts (acc_...).
Pattern:
^acc_[0-9A-Za-z]{22}$Maximum number of conversations to return
Required range:
1 <= x <= 50Opaque pagination cursor. Pass back pagination.nextCursor verbatim; do not construct one.