Profile

Markdown

The creator's public profile.

Fields

  • creatorIdstring · creator idrequired

    The creator's id.

  • slugstringrequired

    The creator's URL slug (read-only).

  • displayNamestringrequired

    The public brand name.

  • realNamestring or nullrequired

    The legal name on the studio profile.

  • biostring or nullrequired

    The bio.

  • emailstringrequired

    The login email (read-only).

  • avatarUrlstring or nullrequired

    The avatar.

  • socialsarray of SocialLinkrequired

    Social links.

    Show 4 fieldsof SocialLink
    • platformstringrequired

      instagram, tiktok or youtube.

      instagramtiktokyoutube
    • handlestringrequired

      The account name (@name). Required on the profile; the link pill shows it when there is no follower count.

    • urlstringrequired

      The profile page (https; set_profile_socials refuses other links). An empty url on a sales page falls back to the link built from platform and handle.

    • followerCountnumberoptional

      Followers as the creator states them, a whole number from 0, shown on the pill (12K) instead of the handle.

  • rolestringrequired

    The key owner's role on the creator account.

    ownereditor

Used by