v8

OpenAPI 3.1.02026-08-033623795.0 MB
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": [
    {
      "platform": "x"
    }
  ]
}