Sign in
Accounts

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.

get/v1/accounts

Query parameters

profileIdstring

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

platformstring

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

status'connected' | 'disconnected'

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.

includeOverLimitboolean

When true, includes accounts from over-limit profiles.

pageinteger

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.

limitinteger

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

Response

Accounts (with optional pagination)

hasAnalyticsAccessboolean required

Whether user has analytics add-on access

Changes

Changed in 1 of the 27 revisions of this API.3

  • 0942091eaa8c3See the full diff
    • ●

      added the new phone enum value to the accounts/items/platform response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new rcs enum value to the accounts/items/platform response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new sms enum value to the accounts/items/platform response property for the response status 200

      response-property-enum-value-added

Of the 27 revisions, 1 has no diff computed.