List Social Accounts

Retrieve connected social accounts for your workspace


List all connected social media accounts in your workspace. Use this to find account IDs for the publish parameter when rendering templates, or for the Publish to Social endpoint.

You can also find account IDs in your dashboard under Social Accounts in the workspace sidebar — each account displays its ID with a Copy ID button.

Endpoint#

GET /social/accounts#

https://api.orshot.com/v1/social/accounts

Request Example#

await fetch("https://api.orshot.com/v1/social/accounts", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

With Account Health#

Pass include_health=true to check if any accounts need reconnection (e.g., expired tokens).

await fetch("https://api.orshot.com/v1/social/accounts?include_health=true", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

Response Example#

{
  "data": [
    {
      "id": 1,
      "platform": "twitter",
      "account_name": "Acme HQ",
      "account_username": "acmehq",
      "account_avatar": "https://pbs.twimg.com/profile_images/.../avatar.jpg",
      "connected_at": "2026-03-15T10:30:00.000Z"
    },
    {
      "id": 2,
      "platform": "linkedin",
      "account_name": "Acme Inc",
      "account_username": "acme-inc",
      "account_avatar": "https://media.licdn.com/.../avatar.jpg",
      "connected_at": "2026-03-16T14:00:00.000Z"
    }
  ]
}

Response Fields#

FieldTypeDescription
idIntegerAccount ID — use this in the publish.accounts array
platformStringPlatform name (twitter, instagram, linkedin, facebook, tiktok, youtube, pinterest, reddit, bluesky, threads, telegram, snapchat, googlebusiness)
account_nameStringDisplay name of the account
account_usernameStringUsername/handle on the platform
account_avatarStringAvatar image URL
connected_atStringISO timestamp when the account was connected
requires_reconnectBooleanWhether the account needs reconnection (only with include_health=true)

Rate Limits#

This endpoint is rate limited to 20 requests per minute per workspace. Rate limit headers are included in every response:

HeaderDescription
X-RateLimit-LimitMaximum requests per minute
X-RateLimit-RemainingRemaining requests in the current window
Retry-AfterSeconds to wait (only on 429 responses)

Error Responses#

CodeDescription
403Missing or invalid API key
429Rate limit exceeded

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 60 free renders — no credit card required