Skip to main content

Users

Overview​

The Users module provides methods to interact with user profiles in the BuiltAPI platform. This module allows you to retrieve and update user profiles.

Methods​

get_profile​

Retrieve the profile of the current user.

Returns​

  • UserProfile: The profile of the current user.

Example​

from builtapi import BuiltAPI

client = BuiltAPI()
profile = client.users.get_profile()
print(profile)

update_profile​

Update the profile of the current user.

Parameters​

  • name (str): The new name of the user.

Returns​

  • UserProfile: The updated user profile.

Example​

from builtapi import BuiltAPI

client = BuiltAPI()
updated_profile = client.users.update_profile(name='New Name')
print(updated_profile)

Schemas​

UserProfile​

{ id: str createdAt: str updatedAt: str externalId: str email: str name: str }