Profile
SchemaRepresents the user profile object. The profile object contains information related to the identity of the user. The data in a profile is tied to a particular work platform account that the user has connected to via .
Fields
· 37id string · uuid required Unique ID of the profile.
created_at string · date-time required Profile creation time (UTC date and time in ISO 8601 format)
updated_at string · date-time required Profile updation time (UTC date and time in ISO 8601 format)
platform_username string · nullable required Username of the connected account. This is used to uniquely identify a user on any platform and usually the name that is present in the URLs, used to tag a user etc.
Ex - For YouTube, it's the channel name in the URL and for Instagram / Twitter / TikTok etc, it's the handle.
full_name string · nullable Full name of the user profile.
first_name string · nullable First name of the user profile.
last_name string · nullable Last name of the user profile.
nick_name string · nullable Nickname of the user profile.
url string · uri Profile URL on the connected platform.
introduction string · nullable Description of the profile.
Ex - For Instagram it's the bio and for YouTube it's the channel introduction.
image_url string · uri URL of the profile image on the platform.
date_of_birth string Date of birth of the user on the platform.
external_id string Unique identifier for the profile on the platform.
platform_account_type string · nullable Account type of the user on the platform.
category string · nullable Category of the user's platform account.
Ex - For Instagram it's the page type which could be beauty, fitness etc
website string · uri· nullable User website listed on the platform.
reputation object Profile reputation object.
emails array of object Emails object.
phone_numbers array of object Phone numbers object.
addresses array of object Addresses object.
gender string · nullable· enum required Gender of the user.
values
MALEFEMALEOTHERUNSPECIFIED
country string Country of the user on the connected platform.
platform_profile_name string · nullable User's profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user's identity on the platform.
Ex - For YouTube, it's the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it's the name displayed on the user's profile page.
platform_profile_id string · nullable Unique profile ID of the user on the work platform.
Ex - For YouTube it's the channel ID and for Instagram it's the Instagram page ID.
platform_profile_published_at string · date-time· nullable Timestamp when the profile was created on the platform.
is_verified boolean · binary true if the user's profile is verified by the platform.
is_business boolean · binary true if the user's profile is business account on the platform.
work_experiences array of WorkExperiences education array of Education publications array of Publications certifications array of Certifications volunteer_experiences array of VolunteerExperiences honors array of Honors projects array of Projects