OverviewProductsPlatformsAPI ReferenceResources
Mentions

List mentions

GEThttps://zernio.com/api/v1/inbox/mentions

Returns mentions of your connected accounts from the last 7 days. Requires Inbox addon.

Authentication

AuthorizationBearer tokenRequired

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

Query parameters

Optional
accountIdstring

Filter by account ID

profileIdstring

Filter by profile ID

sortOrderstringDefault descOne of asc | desc

Sort order by publishedAt

limitintegerDefault 25
cursorstring

Cursor for pagination (ID of the last item from the previous page)

Responses

Success· the request worked

Errors· the request failed

How it behaves

LinkedIn

Organization mentions, delivered by webhooks and a background pull.

Instagram

Comment mentions (someone tags the account in a comment on their own media) and caption mentions (someone tags it in their media caption), delivered by the Meta mentions webhook.

  • Only accounts connected through Facebook Login receive them.
  • Comments on the account's own posts are never listed, even when they contain its @handle.
  • Their text is read from Instagram in the background after the first request, so content can be empty on the first read.
  • Pass mediaId and commentId to POST /v1/inbox/mentions/reply to answer one.

Facebook

Post mentions (someone tags the Page in a post) and comment mentions (someone tags it in a comment), delivered by the Page mention webhook with their text.

  • Comments on the Page's own posts and anything the Page wrote itself are never listed.
  • Facebook mentions cannot be replied to through POST /v1/inbox/mentions/reply.

Reply to review

Post a reply to a review. Requires accountId in request body. ### Idempotency Send an `Idempotency-Key` header to make retries safe (e.g. after a client-side timeout where delivery is unknown). - Same key + same body: replays the original response (with `Idempotent-Replayed: true`) instead of sending the reply to the platform again. - Same key + different body: returns 422. - A key still in flight: returns 409. Keys are retained for 24 hours and are scoped to the credential and to this exact path. Reusing a key against a different reviewId returns 422 rather than replaying the other review's response. ### Failed requests Only successful (2xx) responses are stored for replay. If the request throws or returns a non-2xx status the key is released, so the header protects the "request succeeded but the response was lost" case. After an ambiguous failure (a 5xx or a network timeout), fetch the review before retrying with the same key. Treat a missing reply as inconclusive rather than as proof nothing was sent.

Reply to a mention

Reply to a mention of the connected account. Supported on Instagram only. Two shapes, selected by whether `commentId` is present: - **Comment mention** (someone @mentioned the account inside a comment): pass both `mediaId` and `commentId`. Instagram posts a reply under that comment. - **Caption mention** (someone @mentioned the account in their media caption, so no comment exists): pass `mediaId` only. Instagram posts a comment on their media. Story mentions are not supported by Instagram's API. `GET /v1/inbox/mentions` returns Instagram mentions with the `mediaId` and `commentId` to pass here.

GET/v1/inbox/mentions
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.mentions.listInboxMentions();console.log(data);
{  "data": [    {      "id": "string",      "platform": "linkedin",      "type": "caption",      "mediaId": "string",      "postId": "string",      "commentId": "string",      "accountId": "string",      "accountUsername": "string",      "content": "string",      "contentNotRetained": true,      "permalink": "string",      "authorUrn": "string",      "authorName": "string",      "authorUsername": "string",      "authorPicture": "string",      "organizationalEntity": "string",      "publishedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "hasMore": true,    "cursor": "string"  },  "meta": {    "total": 0,    "sortOrder": "asc"  }}
OpenAPI specification
Was this page helpful?