📱 Social Accounts

Get social media accounts for a workspace

Retrieve paginated list of social media accounts for a specific workspace with optional platform filtering

get/api/v1/workspaces/{workspace_id}/accounts

Path parameters

workspace_idstring required
Example:610a1e660cb41530ca40d372

Workspace ID

Query parameters

platform'facebook' | 'twitter' | 'linkedin' | 'pinterest' | 'instagram' | 'gmb' | 'youtube' | 'tiktok' | 'tumblr' | 'threads' | 'bluesky' | 'telegram'
Example:facebook,instagram,telegram

Filter by platform(s). Use comma-separated values for multiple platforms

searchstring
Example:BloomVille

Search term to filter accounts by name (e.g. 'BloomVille', 'Hello Support')

pageinteger
Example:1

Page number for pagination

per_pageinteger
Example:10

Number of items per page (max: 100)

Response

Accounts retrieved successfully

statusboolean
messagestring
current_pageinteger
per_pageinteger
totalinteger
last_pageinteger
frominteger
tointeger

Example response

{
  "status": true,
  "message": "Accounts retrieved successfully",
  "current_page": 1,
  "per_page": 10,
  "total": 25,
  "last_page": 3,
  "from": 1,
  "to": 10,
  "data": [
    {
      "id": "123456789",
      "_id": "123456789",
      "platform": "telegram",
      "account_name": "My Business Page",
      "profile_picture": "https://example.com/profile.jpg",
      "status": "active",
      "connected_at": "2024-01-15T10:30:00.000Z",
      "expires_at": "2024-03-15T10:30:00.000Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.