Retrieve Social Accounts

Returns a list of social accounts connected to your Vizard workspace.

Use the returned id when publishing videos to a specific platform.

List social accounts

curl -X GET "https://elb-api.vizard.ai/hvizard-server-front/open-api/v1/project/social-accounts" \
  -H "VIZARDAI_API_KEY: YOUR_API_KEY"

Response

{
  "accounts": [
    {
      "id": "12345",
      "platform": "Instagram",
      "username": "user123",
      "page": "pagename",
      "profilePic": "https://example.com/profile.jpg",
      "pageProfilePic": "https://example.com/profile.jpg",
      "expiresAt": 1712956800,
      "status": "active"
    }
  ],
  "total": 10
}

Response fields

accounts (array): Each object represents a connected social account.

FieldTypeDescription
idstringUnique ID of the social account. iUse this value as socialAccountId when publishing.
platformstringSocial platform name (for example, Instagram, TikTok).
usernamestringUsername of the connected account.
pagestringPage name, if applicable (for example, Facebook Pages).
profilePicstringURL of the user profile image.
pageProfilePicstringURL of the page profile image, if applicable.
expiresAtlongUnix timestamp (milliseconds) when the authorization expires.
statusstringCurrent account status.

Account status values

StatusMeaning
activeAccount is connected and ready to publish
expiredAuthorization has expired
lockedAccount is connected, but publishing is disabled because your current plan has reached its social account limit.
not connectedAccount is not connected