List accounts

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

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

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.

Case-insensitive match on the account username, display name or platform user id, or an exact account id. Combine with page/limit to paginate the matches.

Only accounts of this kind. ads = ad accounts (Meta, Google, LinkedIn, Pinterest, TikTok, X, OpenAI, Reddit), communication = WhatsApp, Telegram, Discord, Slack and iMessage, blogs = Shopify and WordPress, crm = HubSpot, social = every other platform.

Sort a paginated listing (page/limit) by account name, platform, profile name, status (accounts needing a reconnect first when ascending) or connection date. Ties keep the default order: platform, then newest first.

Direction for sort.

When true, includes accounts from over-limit profiles.

When true, leaves out accounts the dashboard does not show as connections: posting accounts with enabled: false (ads accounts are always kept, whatever their enabled value) and the internal sms and phone accounts behind each phone number. Applied before pagination, so page totals and statusCounts count only the remaining accounts. Sandbox accounts added by includeSandbox are appended after this filter. Accepts true or false in any letter case; any other value returns 400.

When true, appends the shared WhatsApp sandbox account and the iMessage sandbox account to the list when they are active, honouring platform but no other filter. Ignored on a paginated request (page/limit) and together with perProfile. Accepts true or false in any letter case; any other value returns 400.

When true, the response carries statusCounts: how many accounts match every other filter of the request (with status lifted) in total and how many of those need a reconnection. Accepts true or false in any letter case; any other value returns 400.

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.

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

Comma-separated profile IDs (up to 50) to preview, together with perProfile. The response then also carries profileTotals.

Return a preview of each profile in profileIds: the newest account of every platform it has, topped up to at least N. Requires profileIds; cannot be combined with page and limit.