Skip to main content
DELETE
Delete Account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

xi-api-key
string | null
x-api-key
string | null

Response

Successful Response

uid
string
required
email
string | null
required
email_verified
boolean
required
account_setup
boolean
required
display_name
string
required

Name that is used to identifythe account on the website

provider
string
required

Authentication provider, e.g. 'github'

picture
string | null
required
is_admin
boolean
required
name
string
required

Personal name

first_name
string
required

First name of the user

last_name
string
required

Last name of the user

country
string
required

Country of the user

is_business_account
boolean
required
company
string
required

Company name

website
string
required

Company website address

title
string
required

Job title of the user, e.g. 'Software Engineer'

require_email_verified
boolean
default:false
can_access_agents
boolean
default:false

Whether the user may use the hosted-agents feature (admins, plus the AGENTS_ACCESS_UIDS allowlist)

is_team_account
boolean
default:false
is_team_owner
boolean
default:false
team_role
string | null
team_display_name
string | null
is_team_upgrade_enabled
boolean
default:true
vercel_connection
MeVercelConnection · object | null
google_linked
boolean
default:false

Whether a Google account is linked

show_signup_form
boolean
default:false

Frontend should route the user into the post-signup account-details form

checklist
Checklist · object | null