Skip to Content
API ReferenceAccounts

Accounts

Connect and manage social media accounts. VoxBurst supports OAuth-based account connection for all major platforms.

Base URL

https://api.voxburst.io/v1/accounts

List Accounts

GET /v1/accounts

List all connected social media accounts.

Required scopes: accounts:read

curl https://api.voxburst.io/v1/accounts \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Response

{ "accounts": [ { "id": "acc_123", "platform": "TWITTER", "username": "@voxburst", "displayName": "VoxBurst", "status": "ACTIVE", "connectedAt": "2026-01-15T10:00:00Z" } ] }

Connect Account

POST /v1/accounts/connect/:platform

Initiate OAuth connection for a social media platform. Returns an authorization URL to redirect the user to.

Required scopes: accounts:write

Supported platforms: twitter, linkedin, instagram, facebook, bluesky, threads, pinterest, reddit, tiktok, youtube

Request Body

FieldTypeRequiredDescription
redirectUristringYesURI to redirect to after OAuth authorization
pageModestringNoFor platforms with pages/profiles (e.g. LinkedIn): personal or page
curl -X POST https://api.voxburst.io/v1/accounts/connect/linkedin \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "redirectUri": "https://yourapp.com/oauth/callback", "pageMode": "page" }'

Response

{ "authorizationUrl": "https://twitter.com/oauth/authorize?...", "state": "oauth_state_token" }

Redirect your user to the authorizationUrl. After authorization, the platform will redirect back to your redirectUri with a code and state parameter.


OAuth Callback

POST /v1/accounts/callback/:platform

Complete the OAuth flow by exchanging the authorization code for access tokens.

Required scopes: accounts:write

curl -X POST https://api.voxburst.io/v1/accounts/callback/twitter \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "code": "oauth_authorization_code", "state": "oauth_state_token", "redirectUri": "https://yourapp.com/oauth/callback" }'

Response

{ "account": { "id": "acc_789", "platform": "TWITTER", "username": "@newuser", "displayName": "New User", "status": "ACTIVE", "connectedAt": "2026-02-20T10:00:00Z" } }

Disconnect Account

DELETE /v1/accounts/:id

Disconnect and remove a social media account.

Required scopes: accounts:write

curl -X DELETE https://api.voxburst.io/v1/accounts/acc_123 \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Refresh Account Token

POST /v1/accounts/:id/refresh

Manually refresh the OAuth token for an account. VoxBurst refreshes tokens automatically, but this endpoint is available for troubleshooting.

Required scopes: accounts:write

curl -X POST https://api.voxburst.io/v1/accounts/acc_123/refresh \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Test Connection

POST /v1/accounts/:id/test

Test the connection for a social account by making a lightweight API call to the platform.

Required scopes: accounts:read

curl -X POST https://api.voxburst.io/v1/accounts/acc_123/test \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Response

{ "success": true, "latencyMs": 243, "platform": "INSTAGRAM" }

List Pages

GET /v1/accounts/:id/pages

List available LinkedIn pages and Facebook pages for an account. Only applicable for accounts connected in page mode.

Required scopes: accounts:read

curl https://api.voxburst.io/v1/accounts/acc_123/pages \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx"

Response

{ "pages": [ { "id": "page_001", "name": "VoxBurst Official", "type": "ORGANIZATION", "followerCount": 4200 } ] }

Select Page

POST /v1/accounts/:id/select-page

Persist a page selection for an account (LinkedIn/Facebook). Posts to this account will be published to the selected page.

Required scopes: accounts:write

curl -X POST https://api.voxburst.io/v1/accounts/acc_123/select-page \ -H "Authorization: Bearer sk_live_xxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "pageId": "page_001" }'

Account Status

StatusDescription
ACTIVEAccount is connected and tokens are valid
EXPIREDToken has expired, refresh required
REVOKEDUser has revoked access, reconnection required
ERRORAccount has an error, check details
Last updated on