Zernio
Zernio
API Reference

Accounts

List accountsGETCheck account healthGETList posts published on the platformGETCheck accounts healthGETGet Bluesky account settingsGETGet follower statsGETCheck whether an Instagram user follows the accountGETGet Slack account settingsGETGet TikTok creator infoGETUpdate accountPUTUpdate Bluesky account settingsPATCHUpdate Slack account settingsPATCHDisconnect accountDELETEMove account to another profilePATCH
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Accounts

List accounts

Returns connected 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.

GET
/v1/accounts

Authorization

bearerAuth
AuthorizationBearer <token>

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

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

application/json

application/json

application/json

{  "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}
Was this page helpful?

Delete profile

Permanently deletes a profile. Active connected accounts block deletion (returns 400) - disconnect them first. Any remaining disconnected accounts and provisioned WhatsApp numbers are moved to another of your profiles (a new one is created only if needed), never deleted.

Check account health

Returns detailed health info for a specific account including token status, permissions, and recommendations. For WhatsApp accounts the response also includes `platformConnection`, a live probe of the Meta link behind the channel (the same read as `GET /v1/whatsapp/number-info`). The OAuth token can be perfectly valid while Meta refuses to serve the phone-number object (for example after a phone-side coexistence disconnect), so `tokenStatus` alone is not a liveness signal for WhatsApp. When the Meta link is dead, `platformConnection.status` is `disconnected` and the overall `status` is `error`.