Inbox · Mentions

List mentions

Returns mentions, one page at a time.

GEThttps://api.pozy.ai/v1/inbox/mentions

listInboxMentions

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
`accountId`	string
`profileId`	string
`sortOrder`	string	One of `asc`, `desc`Default `desc`
`limit`	integer	Default `25`1 to 100
`cursor`	string

Example

curl -X GET "https://api.pozy.ai/v1/inbox/mentions?limit=25" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/inbox/mentions?limit=25", {
  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/mentions",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 25,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

dataarray of object
17 child fields
- idstring
- platformstring
  One of linkedin, instagram, facebook.
- typestring
  One of caption, post, comment. Can be null.
- mediaIdstring
  Can be null.
- postIdstring
  Can be null.
- commentIdstring
  Can be null.
- accountIdstring
- accountUsernamestring
- contentstring
- permalinkstring
  Can be null.
- authorUrnstring
  Can be null.
- authorNamestring
  Can be null.
- authorUsernamestring
  Can be null.
- authorPicturestring
  Can be null.
- organizationalEntitystring
- publishedAtstring (date-time)
- createdAtstring (date-time)
paginationobject
- hasMoreboolean
- cursorstring
  Can be null.
metaobject
- totalinteger
- sortOrderstring
  One of asc, desc.

200 response

{
  "data": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "platform": "linkedin",
      "type": "caption",
      "mediaId": "69eaa09f981d518a7e5ab560",
      "postId": "6108a2cc742cb4e991051e0c",
      "commentId": "6cc7605fa43607e4ad43b1d4",
      "accountId": "696e0b682d0a31188e7a2ba9",
      "accountUsername": "acme",
      "content": "Hello from Pozy",
      "permalink": "string",
      "authorUrn": "string",
      "authorName": "Acme",
      "authorUsername": "acme",
      "authorPicture": "string",
      "organizationalEntity": "string",
      "publishedAt": "2026-10-02T09:00:00.000Z",
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "string"
  },
  "meta": {
    "total": 42,
    "sortOrder": "asc"
  }
}

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.

More in Mentions

POSTReply to a mention