List Social Accounts
Retrieve connected social accounts for your workspace
Published ·Updated
/v1/social/accountscurl -X GET "https://api.orshot.com/v1/social/accounts" \
-H "Authorization: Bearer <ORSHOT_API_KEY>"const res = await fetch("https://api.orshot.com/v1/social/accounts", {
method: "GET",
headers: {
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});
const data = await res.json();import requests
response = requests.get(
"https://api.orshot.com/v1/social/accounts",
headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
)
data = response.json()$ch = curl_init("https://api.orshot.com/v1/social/accounts");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer <ORSHOT_API_KEY>",
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);require "net/http"
require "json"
uri = URI("https://api.orshot.com/v1/social/accounts")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)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.
Multiple accounts from the same platform are returned as separate entries with
different id values. Always store and publish with the account id, not only
the platform name.
You can also find account IDs in the dashboard. Open Social Posting → Accounts, then use Copy ID in an account's ⋯ menu.
Endpoint#
GET /social/accounts#
https://api.orshot.com/v1/social/accountsRequest 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>",
},
});Filter by Your Reference#
Accounts connected through a connect link carry the external_id you gave. Filter on it to find one person's account.
await fetch("https://api.orshot.com/v1/social/accounts?external_id=office_142", {
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",
"external_id": null,
"connect_source": null,
"provider": "zernio"
},
{
"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",
"external_id": "office_142",
"connect_source": "api",
"provider": "zernio"
}
]
}The requires_reconnect field only appears when include_health=true is passed. If true, the account's token has expired and needs to be reconnected from the dashboard.
Response Fields#
| Field | Type | Description |
|---|---|---|
id | Integer | Account ID — use this in the publish.accounts array |
platform | String | Platform name (twitter, instagram, linkedin, facebook, tiktok, youtube, pinterest, reddit, bluesky, threads, telegram, snapchat, googlebusiness, whatsapp, discord) |
account_name | String | Display name of the account |
account_username | String | Username/handle on the platform |
account_avatar | String | Avatar image URL |
connected_at | String | ISO timestamp when the account was connected |
requires_reconnect | Boolean | Whether the account needs reconnection (only with include_health=true) |
external_id | String | Your reference from the connect link that created the account, else null |
connect_source | String | api or mcp for accounts connected through a connect link, null for the dashboard |
provider | String | The publishing provider the account routes through (zernio) |
limits | Object | X accounts only: link_posts (posts with a link this month: 25, 80 or 100 by plan) and posts_today (15 a day), each with used, limit, left and resets_at. See X limits |
Rate Limits#
This endpoint is rate limited to 20 requests per minute per workspace. Rate limit headers are included in every response:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests per minute |
X-RateLimit-Remaining | Remaining requests in the current window |
Retry-After | Seconds to wait (only on 429 responses) |
Error Responses#
| Code | Description |
|---|---|
| 401 | Invalid or expired API key |
| 403 | Missing Authorization header |
| 429 | Rate 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 40+ integrations
- White-label embed for your own app
- 100 free credits a month, no credit card required