Account
SchemaRepresents work platform accounts that your users link via . Once a user connects a work platform account from the Connect SDK then an account object is created for the user.
Fields
· 12id string · uuid required Unique ID of the connected account.
created_at string · date-time required Account creation time (UTC date and time in ISO 8601 format)
updated_at string · date-time required Account 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.
profile_pic_url string · uri· nullable URL of the user's profile image from the work platform.
status string · enum required Account connection status.
values
CONNECTEDNOT_CONNECTEDSESSION_EXPIRED
platform_profile_name string required 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 required 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.
data object required Represents the information category which is available for the connected account.