List accounts

Returns connected social accounts. Only includes accounts within the plan limit by default. Follower data requires analytics add-on. Supports optional server-side pagination via page/limit params. When omitted, returns all accounts (backward-compatible). page and limit must be supplied together; out-of-range page/limit values are rejected with 400 rather than silently clamped.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Query Parameters

profileId?string

Filter accounts by profile ID. Must be a valid ObjectId.

platform?string

Filter accounts by platform (e.g. "instagram", "twitter").

status?string

Filter accounts by connection status. connected returns healthy accounts; disconnected returns accounts that need reconnection (per the same reconnection check surfaced in the dashboard). Omit to return accounts in any status. When combined with page/limit, pagination totals reflect the filtered result set.

Value in"connected" | "disconnected"

includeOverLimit?boolean

When true, includes accounts from over-limit profiles.

Defaultfalse

page?integer

Page number (1-based). Must be provided together with limit to enable server-side pagination; sending only one of the two returns 400. Omit both for all accounts.

Range1 <= value

limit?integer

Page size. Must be provided together with page; sending only one of the two returns 400.

Range1 <= value <= 100

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.accounts.listAccounts();console.log(data);

{
  "accounts": [
    {
      "_id": "64e1...",
      "platform": "twitter",
      "profileId": {
        "_id": "64f0...",
        "name": "My Brand",
        "slug": "my-brand"
      },
      "username": "@acme",
      "displayName": "Acme",
      "profileUrl": "https://x.com/acme",
      "isActive": true
    }
  ],
  "hasAnalyticsAccess": false
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

List accounts

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Query Parameters

profileId?string

Filter accounts by profile ID. Must be a valid ObjectId.

platform?string

Filter accounts by platform (e.g. "instagram", "twitter").

status?string

Value in"connected" | "disconnected"

includeOverLimit?boolean

When true, includes accounts from over-limit profiles.

Defaultfalse

page?integer

Page number (1-based). Must be provided together with limit to enable server-side pagination; sending only one of the two returns 400. Omit both for all accounts.

Range1 <= value

limit?integer

Page size. Must be provided together with page; sending only one of the two returns 400.

Range1 <= value <= 100

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.accounts.listAccounts();
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.accounts.listAccounts();console.log(data);

{
  "accounts": [
    {
      "_id": "64e1...",
      "platform": "twitter",
      "profileId": {
        "_id": "64f0...",
        "name": "My Brand",
        "slug": "my-brand"
      },
      "username": "@acme",
      "displayName": "Acme",
      "profileUrl": "https://x.com/acme",
      "isActive": true
    }
  ],
  "hasAnalyticsAccess": false
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

List accounts

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

List accounts

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

application/json

application/json

application/json

application/json

application/json

application/json