Inbox · Comments
Returns commented posts, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the engagement resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
profileId | string | |
platform | string | One of facebook, instagram, twitter, bluesky, threads, youtube, linkedin, reddit, tiktok, metaads |
minComments | integer | At least 0 |
since | string (date-time) | |
sortBy | string | One of date, commentsDefault date |
sortOrder | string | One of asc, descDefault desc |
limit | integer | Default 501 to 100 |
cursor | string | |
accountId | string |
Example
curl -X GET "https://api.pozy.ai/v1/inbox/comments?limit=50" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/inbox/comments?limit=50", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/inbox/comments",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 50,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
dataarray of object15 child fields
idstringplatformstringaccountIdstringaccountUsernamestringcontentstringpicturestringCan be null.
permalinkstringCan be null.
createdTimestring (date-time)commentCountintegerlikeCountintegercidstringCan be null.
subredditstringCan be null.
isAdbooleanadIdstringplacementstringOne of
facebook,instagram.
paginationobjecthasMorebooleannextCursorstringCan be null.
metaobjectaccountsQueriedintegeraccountsFailedintegerfailedAccountsarray of object6 child fields
accountIdstringaccountUsernamestringCan be null.
platformstringerrorstringcodestringCan be null.
retryAfterintegerCan be null.
lastUpdatedstring (date-time)accountsSkippedarray of object2 child fields
accountIdstringplatformstring
200 response
{
"data": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"platform": "instagram",
"accountId": "696e0b682d0a31188e7a2ba9",
"accountUsername": "acme",
"content": "Hello from Pozy",
"picture": "string",
"permalink": "string",
"createdTime": "2026-10-02T09:00:00.000Z",
"commentCount": 42,
"likeCount": 42,
"cid": "60cc682239f4a5a15c99a784",
"subreddit": "string",
"isAd": true,
"adId": "6f40fa2fb0a7e728dd1a73b7",
"placement": "facebook"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "string"
},
"meta": {
"accountsQueried": 42,
"accountsFailed": 42,
"failedAccounts": [
{
"accountId": "696e0b682d0a31188e7a2ba9",
"accountUsername": "acme",
"platform": "instagram",
"error": "string",
"code": "string",
"retryAfter": 1
}
],
"lastUpdated": "2026-10-02T09:00:00.000Z",
"accountsSkipped": [
{
"accountId": "696e0b682d0a31188e7a2ba9",
"platform": "instagram"
}
]
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.