curl --request GET \
--url https://api.aisa.one/apis/v1/social/inbox/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/social/inbox/conversations"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/social/inbox/conversations")
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": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"adAttribution": {
"adAccountId": "<string>",
"adAccountName": "<string>",
"adId": "<string>",
"adSetId": "<string>",
"adSetName": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"isExternal": true,
"name": "<string>",
"platformPostId": "<string>",
"synced": true
},
"businessScopedUserId": "<string>",
"folder": "requests",
"id": "<string>",
"instagramProfile": {
"fetchedAt": "2023-11-07T05:31:56Z",
"followerCount": 123,
"isFollower": true,
"isFollowing": true,
"isVerified": true
},
"isGroup": true,
"lastMessage": "<string>",
"metadata": {
"ctwa_body": "<string>",
"ctwa_captured_at": "2023-11-07T05:31:56Z",
"ctwa_clid": "<string>",
"ctwa_headline": "<string>",
"ctwa_image_url": "<string>",
"ctwa_media_type": "<string>",
"ctwa_source_id": "<string>",
"ctwa_source_type": "<string>",
"ctwa_source_url": "<string>",
"ctwa_thumbnail_url": "<string>",
"ctwa_video_url": "<string>",
"meta_ad_captured_at": "2023-11-07T05:31:56Z",
"meta_ad_flow_id": "<string>",
"meta_ad_id": "<string>",
"meta_ad_photo_url": "<string>",
"meta_ad_post_id": "<string>",
"meta_ad_product_id": "<string>",
"meta_ad_ref": "<string>",
"meta_ad_source": "<string>",
"meta_ad_title": "<string>",
"meta_ad_type": "<string>",
"meta_ad_video_url": "<string>"
},
"pageId": "<string>",
"participantId": "<string>",
"participantName": "<string>",
"participantPicture": "<string>",
"participantVerifiedType": "blue",
"platform": "<string>",
"status": "active",
"threadControl": "app",
"unreadCount": 123,
"updatedTime": "2023-11-07T05:31:56Z",
"url": "<string>",
"whatsappUsername": "<string>"
}
],
"meta": {
"accountsFailed": 123,
"accountsQueried": 123,
"accountsSkipped": [
{
"accountId": "<string>",
"platform": "<string>"
}
],
"failedAccounts": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"code": "<string>",
"error": "<string>",
"platform": "<string>",
"retryAfter": 123
}
],
"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>"
}
}List conversations
curl --request GET \
--url https://api.aisa.one/apis/v1/social/inbox/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aisa.one/apis/v1/social/inbox/conversations"
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', 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",
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"
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")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/social/inbox/conversations")
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": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"adAttribution": {
"adAccountId": "<string>",
"adAccountName": "<string>",
"adId": "<string>",
"adSetId": "<string>",
"adSetName": "<string>",
"campaignId": "<string>",
"campaignName": "<string>",
"isExternal": true,
"name": "<string>",
"platformPostId": "<string>",
"synced": true
},
"businessScopedUserId": "<string>",
"folder": "requests",
"id": "<string>",
"instagramProfile": {
"fetchedAt": "2023-11-07T05:31:56Z",
"followerCount": 123,
"isFollower": true,
"isFollowing": true,
"isVerified": true
},
"isGroup": true,
"lastMessage": "<string>",
"metadata": {
"ctwa_body": "<string>",
"ctwa_captured_at": "2023-11-07T05:31:56Z",
"ctwa_clid": "<string>",
"ctwa_headline": "<string>",
"ctwa_image_url": "<string>",
"ctwa_media_type": "<string>",
"ctwa_source_id": "<string>",
"ctwa_source_type": "<string>",
"ctwa_source_url": "<string>",
"ctwa_thumbnail_url": "<string>",
"ctwa_video_url": "<string>",
"meta_ad_captured_at": "2023-11-07T05:31:56Z",
"meta_ad_flow_id": "<string>",
"meta_ad_id": "<string>",
"meta_ad_photo_url": "<string>",
"meta_ad_post_id": "<string>",
"meta_ad_product_id": "<string>",
"meta_ad_ref": "<string>",
"meta_ad_source": "<string>",
"meta_ad_title": "<string>",
"meta_ad_type": "<string>",
"meta_ad_video_url": "<string>"
},
"pageId": "<string>",
"participantId": "<string>",
"participantName": "<string>",
"participantPicture": "<string>",
"participantVerifiedType": "blue",
"platform": "<string>",
"status": "active",
"threadControl": "app",
"unreadCount": 123,
"updatedTime": "2023-11-07T05:31:56Z",
"url": "<string>",
"whatsappUsername": "<string>"
}
],
"meta": {
"accountsFailed": 123,
"accountsQueried": 123,
"accountsSkipped": [
{
"accountId": "<string>",
"platform": "<string>"
}
],
"failedAccounts": [
{
"accountId": "<string>",
"accountUsername": "<string>",
"code": "<string>",
"error": "<string>",
"platform": "<string>",
"retryAfter": 123
}
],
"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
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/social/inbox/conversations - profileId: query; optional
- platform: query; optional
- status: query; optional
- folder: query; optional
- sortOrder: query; optional
- limit: query; optional
- cursor: query; optional
- accountId: query; optional
- tags: query; optional
- Runtime facts: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
{
"operationId": "get_aisa_social_apis_v1_social_inbox_conversations",
"method": "GET",
"path": "/apis/v1/social/inbox/conversations",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"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",
"in": "query",
"name": "platform",
"required": false,
"schema": {
"enum": [
"facebook",
"instagram",
"twitter",
"bluesky",
"reddit",
"telegram",
"whatsapp",
"imessage",
"sms"
],
"type": "string"
}
},
{
"description": "Filter by conversation status",
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"active",
"archived"
],
"type": "string"
}
},
{
"description": "`requests` lists Facebook Page Message Requests (threads from people the account has not accepted) live from Meta, each item with `folder: requests`.\n\nMeta has no accept call: replying moves a thread to the inbox, which is what POST /apis/v1/social/inbox/conversations/{conversationId}/accept does.\n\n- When Meta will not list the folder for the one account asked (`accountId`), the call answers 400 PLATFORM_LIMITATION. Across several accounts, the refusal is reported per account in meta.failedAccounts.\n- Instagram accounts (Instagram Login and Facebook Login) answer PLATFORM_LIMITATION, because Meta does not separate the folder on Instagram. Only Facebook Pages are served.\n\nOne page of up to `limit` threads. `pagination.hasMore` is true when threads past `limit` were cut (narrow with `accountId`). `pagination.nextCursor` is always null and a `cursor` answers 400.",
"in": "query",
"name": "folder",
"required": false,
"schema": {
"default": "inbox",
"enum": [
"inbox",
"requests"
],
"type": "string"
}
},
{
"description": "Sort order by updated time",
"in": "query",
"name": "sortOrder",
"required": false,
"schema": {
"default": "desc",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
{
"description": "Maximum number of conversations to return; values above 100 are served as 100.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "Pagination cursor for next page",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"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": "Comma-separated contact tags. Returns only conversations whose contact has any of them. Cannot be combined with folder=requests.",
"in": "query",
"name": "tags",
"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
One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.
^prf_[0-9A-Za-z]{22}$Filter by platform
facebook, instagram, twitter, bluesky, reddit, telegram, whatsapp, imessage, sms Filter by conversation status
active, archived requests lists Facebook Page Message Requests (threads from people the account has not accepted) live from Meta, each item with folder: requests.
Meta has no accept call: replying moves a thread to the inbox, which is what POST /apis/v1/social/inbox/conversations/{conversationId}/accept does.
- When Meta will not list the folder for the one account asked (
accountId), the call answers 400 PLATFORM_LIMITATION. Across several accounts, the refusal is reported per account in meta.failedAccounts. - Instagram accounts (Instagram Login and Facebook Login) answer PLATFORM_LIMITATION, because Meta does not separate the folder on Instagram. Only Facebook Pages are served.
One page of up to limit threads. pagination.hasMore is true when threads past limit were cut (narrow with accountId). pagination.nextCursor is always null and a cursor answers 400.
inbox, requests Sort order by updated time
asc, desc Maximum number of conversations to return; values above 100 are served as 100.
1 <= x <= 100Pagination cursor for next page
One of your social accounts (acc_...).
^acc_[0-9A-Za-z]{22}$Comma-separated contact tags. Returns only conversations whose contact has any of them. Cannot be combined with folder=requests.