Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Query Parameters

account_id
string

The Account that the social accounts are connected to. Provide either this or user_id.

user_id
string

The User that the social accounts are connected to. Provide either this or account_id.

platform
enum<string>

Only return social accounts for the platform that is specified.

Available options:
x,
instagram,
youtube,
tiktok,
facebook,
discord,
telegram
verified
boolean

Only return social accounts that are verified on the platform.

scopes
enum<string>[]

Only return social accounts that have these scopes.

Available options:
advertise
first
integer
default:20

The number of social accounts to return.

Required range: x <= 100
after
string

Cursor to fetch the page after (from page_info.end_cursor).

last
integer

The number of social accounts to return from the end of the range.

Required range: x <= 100
before
string

Cursor to fetch the page before (from page_info.start_cursor).

order
enum<string>
default:display_order

The field to sort social accounts by.

Available options:
display_order,
created_at
direction
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc

Response

filtered to accounts holding the requested scope

data
object[]
required
page_info
object
required