v2

latestOpenAPI 3.0.22026-08-07295198367.7 KB
Profile

Get Profile

Get user profile information.

get/profile

Query parameters

team_idstring uuid

Response

Successful Response

idstring uuid required

The ID of the user.

profile_picturestring

URL of the user's profile picture.

full_namestring required

The full name of the user.

emailstring required

The email address of the user.

tier_idstring uuid required

The ID of the user's tier.

tier_namestring required

The name of the user's tier.

monthly_messages_usedinteger required

The number of monthly messages used by the user.

monthly_message_limitinteger required

The monthly message limit for the user.

tier_notestring

Additional note or description about the user's tier.

date_createdstring date-time

User creation time.

tier_price_as_floatnumber

Price per tier (monthly or yearly).

tier_typestring

Tier type.

tier_on_trialboolean

Tier on trial flag

trial_usedboolean

Tier trial has been used

user_openai_api_keystring

The OpenAI key of the user

has_created_chatbotboolean
show_fifty_percent_discountboolean
selected_team_idstring uuid
requires_2FAboolean
stripe_customer_idstring

Stripe customer ID.

enabled_realtime_voiceboolean
applied_one_dollar_bf_starterboolean
applied_25_percent_bf_discountboolean
can_access_new_designboolean