OpenAPI 3.1.02026-08-153864115.7 MB
c301132dbfd7
Social Accounts
List Social Accounts
Lists the social accounts linked to an account or user.
get/social_accounts
Query parameters
account_idstring
The Account that the social accounts are connected to. Provide either this or user_id.
user_idstring
The User that the social accounts are connected to. Provide either this or account_id.
platform'x' | 'instagram' | 'youtube' | 'tiktok' | 'facebook' | 'discord' | 'telegram'
Only return social accounts for the platform that is specified.
verifiedboolean
Only return social accounts that are verified on the platform.
scopesstring[]
Only return social accounts that have these scopes.
firstinteger
The number of social accounts to return.
afterstring
Cursor to fetch the page after (from page_info.end_cursor).
lastinteger
The number of social accounts to return from the end of the range.
beforestring
Cursor to fetch the page before (from page_info.start_cursor).
order'display_order' | 'created_at'
The field to sort social accounts by.
direction'asc' | 'desc'
Sort direction.
Response
filtered to accounts holding the requested scope
Example response
{
"data": [
{
"error": "You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again.",
"external_id": "1234567891",
"id": "sacc_xxxxxxxxxxxxxx",
"name": "Shine Time Auto Detailing",
"parent_social_account": {
"external_id": "555111",
"id": "sacc_xxxxxxxxxxxxxx",
"name": "Shine Time Auto Detailing",
"platform": "facebook",
"profile_picture_url": "https://shinetime.example/logo.png",
"username": "shinetimedetailing",
"verified": true
},
"platform": "instagram",
"profile_picture_url": "https://shinetime.example/logo.png",
"scopes": [
"advertise"
],
"url": "https://instagram.com/shinetimedetail",
"username": "shinetimedetail",
"verified": true
}
],
"page_info": {
"end_cursor": "WyJjdXJzb3IiLDFd",
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}