Skip to main content
GET
Get current user

Authorizations

Authorization
string
header
required

JWT authentication token

Response

User profile information

email
string<email>
required

User's email address

features
object
required

Feature flags for the user (booleans like neo_ai, numbers like neo_credits)

Example:
model_use_mode
enum<string>
required

Effective model source for the current user.

Available options:
neo,
byok,
ai_connections
model_use_scope
object
required
role
enum<string>
required

User's role in the system

Available options:
user,
admin
target_identity_simulation_enabled
boolean
default:true
required

Whether automatic target identity simulation is enabled for this user.

ai_connection_models
object[]

Models exposed by the user's AI connections. Returned when AI connections are selected.

available_models
string[]

List of canonical Neo model IDs available for the user. In BYOK mode this contains only discovered provider models that Neo supports.

byok_models
object[]

Provider-discovered BYOK models with Neo support classification. Returned when the user is in BYOK mode.

cap
object | null

Caller's own effective spending-cap status (source/limit/used/remaining). Null for solo / no-team users or when the team isn't on a spend-controls plan. Drives the user's own cap banner.

egress_ip
object | null

Outbound IP information for customer allowlists

neo_cost_rate
number<float> | null

Effective BYOK neo cost rate for the user. Returned when the user is in BYOK mode.

onboarding
object

Onboarding status flags for the user (active subscription, team membership)

source_type
enum<string> | null

Event the account's credits were attributed to, via a promo code or an admin grant. Null for users with no event attribution.

Available options:
blackhat,
defcon
tag
string | null

Effective UI cohort tag. Solo users receive their stored tag. Active team admins and members receive the highest-priority stored tag among accepted/auto-joined team admins; ordinary member tags are ignored while on the team. self_serve is a persistent cohort marker and can represent active, past_due, scheduled-cancel, or canceled customers; billing status and accounting_mode remain authoritative for access.

team
object | null

Team membership information (null if user is not in a team)