Comment Plugs

Get Comment Plug config

Reads the default Comment Plug (automatic first-comment) settings for one or all accounts in the workspace: LinkedIn profiles, company pages and X accounts. On X the plug posts as a self-reply to the first tweet.

GET/api/public/comment-plugs/config
cURLGET /api/public/comment-plugs/config
curl "https://postiv.ai/api/public/comment-plugs/config" \
  -H "Authorization: Bearer pk_postiv_..."
200Response
{
  "success": true,
  "orgId": "9e6397ad-...",
  "profiles": [
    {
      "id": 1234,
      "channel": "linkedin",
      "profileType": "personal",
      "name": "Jan",
      "cmmConnected": true,
      "plugReady": true,
      "config": {
        "enabled": true,
        "delayMinutes": 30,
        "selectionMode": "random",
        "variants": [
          {
            "id": "v1",
            "text": "Grab the template here: ...",
            "useWhen": null,
            "imageSource": null
          }
        ]
      }
    }
  ],
  "config": null,
  "warnings": []
}

Authorization

Requires an organization API key with the profiles:read scope, sent as Authorization: Bearer or x-api-key.

Query parameters

integrationIdint

One account (LinkedIn or X). Alias: integration_id. Omit to list all accounts. An account decides the channel.

channelstring

Narrow the list to one channel. Omit for LinkedIn and X together. A channel that contradicts integrationId's channel returns 400 channel_mismatch.

One of:linkedinx

Response

Profiles with their Comment Plug config (defaulted when unset).

orgIduuid
profiles[].idint
profiles[].channelstring

Channel of the account.

profiles[].profileTypestring
profiles[].namestring|null
profiles[].usernamestring|null

X handle. Null for LinkedIn.

profiles[].cmmConnectedboolean

LinkedIn only: whether LinkedIn's comment-management permission is connected; enabled LinkedIn configs require this true. Not returned for X accounts.

profiles[].plugReadyboolean

Whether the plug can run: cmmConnected for LinkedIn, an active connection for X.

profiles[].config.enabledboolean
profiles[].config.delayMinutesint

Default/minimum 2.

profiles[].config.selectionModestring
profiles[].config.variantsarray

[{ id, text, useWhen, imageSource }]

configobject|null

Convenience: same as profiles[0].config when integrationId was passed; null otherwise.

warningsstring[]

e.g. a note if the comment_plug_configs table isn't migrated yet.

Errors

400invalid_integration_id: integrationId not a positive integer / invalid_channel: channel is not linkedin or x
404integration_not_found: integrationId given but not an account in this workspace (or an X account that needs reconnecting)
400channel_mismatch: channel contradicts the channel of integrationId

Good to know

  • Call before relying on schedule_post's commentPlug 'inherit' mode: inherit only actually posts a comment when enabled, has variants, and plugReady is true (cmmConnected for LinkedIn; an active X account is always ready).