Accounts
An account is one provider connection inside a profile. Its accountId is the
identifier every other endpoint takes.
The account object
List accounts returns these records, and Get account returns one bare.
Account fields
accountIduuid- Use this everywhere.
idis the same value, kept for clients that expect it. providerIdstring- Instagram's user id, or TikTok's app-scoped open_id. Informational — do not send it back as an accountId. A TikTok account's open_id changed once, when it reconnected through TikTok API for Business. For YouTube, the channel id (UC…). For X, the user id, which survives a change of username. For Bluesky, the account's DID (did:plc:…), which survives a change of handle.
displayNamestring- For Instagram, "@" plus the username. For TikTok, the profile display name. For YouTube, the channel title. For X, the account name. For Bluesky, the display name, or the handle when there is none.
displayIdentifierstring- The Instagram username, or the TikTok username (its open_id for a connection that has not reconnected since the move to TikTok API for Business), or the YouTube channel handle, such as @adeli (its channel id when it has none), or the X username, or the Bluesky handle.
authMethod"instagram_login" | "facebook_login"- Instagram only: the login the account was connected with. Reconnecting uses the same one; see Instagram login methods.
connectionStatusstringconnected;expiredwhen an Instagram connection has lapsed or, for Facebook Login, its Page can no longer be reached;reconnect_requiredwhen TikTok, Facebook, YouTube, X, or Bluesky needs fresh consent;pending_page_selectionwhen a Facebook connection exists but no Page has been chosen.
Endpoints
GETList accounts
/api/v1/accountsEvery connected account in one profile.GETList profile accounts/api/v1/profiles/{profileId}/accountsThe same list, scoped by path instead of query.GETGet account/api/v1/profiles/{profileId}/accounts/{accountId}One connected account, as a bare object.PATCHUpdate X account/api/v1/profiles/{profileId}/accounts/{accountId}Turn an X account's billed background reads on or off.POSTRefresh tokens/api/v1/profiles/{profileId}/accounts/refreshRefresh the OAuth tokens of every connection in a profile.DELETEDisconnect account/api/v1/profiles/{profileId}/accounts/{accountId}Delete Adeli's credentials and cached history for one connection.