Skip to main content
POST
Fetch a profile

Authorizations

x-api-key
string
header
required

Body

application/json

The profile to fetch

user_account_id
string

The ID of the user account. Required if platform_account_id and user_platform are not provided

Example:

"47f85f19-60fc-4524-9c99-42a96c286d86"

platform_account_id
string

The platform account ID. Required if user_account_id is not provided (must be used with user_platform)

Example:

"UC_12345"

user_platform
enum<string>

The user platform. Required if user_account_id is not provided (must be used with platform_account_id)

Available options:
YOUTUBE,
TIKTOK,
INSTAGRAM,
INSTAPRO,
FACEBOOK,
X,
LINKEDIN
Example:

"YOUTUBE"

Response

Profile fetched successfully

id
string
required

Unique identifier for the profile

Example:

"65170d1b-6720-5e63-ae7a-86c8d6510db9"

user_platform
string
required

The platform where this profile exists

Example:

"YOUTUBE"

username
string
required

Username on the platform

Example:

"johndoe"

url
string
required

URL to the profile on the platform

Example:

"https://www.youtube.com/channel/UC1234567890"

gender
string
required

Gender of the profile owner

Example:

"MALE"

platform_account_id
string
required

Unique identifier for the account on the platform

Example:

"UC1234567890"

full_name
string
required

Full name of the profile owner

Example:

"John Doe"

first_name
string
required

First name of the profile owner

Example:

"John"

last_name
string
required

Last name of the profile owner

Example:

"Doe"

nick_name
string
required

Nickname of the profile owner

Example:

"Johnny"

display_name
string
required

Display name shown on the platform

Example:

"John Doe"

description
string
required

Profile bio or description

Example:

"Tech enthusiast sharing coding tutorials and tech reviews. New videos every week!"

profile_picture_url
string
required

URL to the profile picture

Example:

"https://yt3.ggpht.com/sample-profile-picture"

date_of_birth
string
required

Date of birth of the profile owner

Example:

"1990:01:15"

category
string
required

Category or niche of the profile

Example:

"Technology"

website_url
string
required

URL to the personal website

Example:

"https://www.johndoe.com"

country
string
required

Country code of the profile owner

Example:

"US"

emails
object[]
required

Array of email addresses associated with the profile

phone_numbers
object[]
required

Array of phone numbers associated with the profile

addresses
object[]
required

Array of addresses associated with the profile

followers_count
number
required

Number of followers the profile has

Example:

10000

following_count
number
required

Number of accounts the profile is following

Example:

500

subscribers_count
number
required

Number of subscribers the profile has

Example:

50000

contents_count
number
required

Number of content items posted by the profile

Example:

200

watch_time_in_hours
number
required

Total watch time of profile content in hours

Example:

150000

joined_at
string
required

Date when the profile was created on the platform

Example:

"2015-03-15T12:00:00.000Z"

verified
boolean
required

Whether the profile is verified on the platform

Example:

true