v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Get User Info

Gets information about the user

get/v1/user

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

user_idstring required

The unique identifier of the user.

is_new_userboolean required

Whether the user is new. This field is deprecated and will be removed in the future. Use 'created_at' instead.

xi_api_keystring nullable

The API key of the user.

can_use_delayed_payment_methodsboolean required

This field is deprecated and will be removed in a future major version. Instead use subscription.trust_on_invoice_creation.

is_onboarding_completedboolean required

Whether the user's onboarding is completed.

is_onboarding_checklist_completedboolean required

Whether the user's onboarding checklist is completed.

show_compliance_termsboolean

Whether to show compliance terms (ToS, Privacy Policy, biometric consent) during onboarding. Set for users signing up from the marketing site.

first_namestring nullable

First name of the user.

is_api_key_hashedboolean

Whether the user's API key is hashed.

xi_api_key_previewstring nullable

The preview of the user's API key.

referral_link_codestring nullable

The referral link code of the user.

partnerstack_partner_default_linkstring nullable

The Partnerstack partner default link of the user.

created_atinteger required

The unix timestamp of the user's creation. 0 if the user was created before the unix timestamp was added.

seat_type'workspace_admin' | 'workspace_member' | 'workspace_lite_member' required

Seat types for workspace members.

Example response

{
  "can_use_delayed_payment_methods": false,
  "created_at": 1753999199,
  "first_name": "John",
  "is_api_key_hashed": false,
  "is_new_user": false,
  "is_onboarding_checklist_completed": true,
  "is_onboarding_completed": true,
  "seat_type": "workspace_member",
  "show_compliance_terms": false,
  "subscription": {
    "allowed_to_extend_character_limit": false,
    "billing_period": "monthly_period",
    "can_extend_character_limit": false,
    "can_extend_voice_limit": false,
    "can_use_instant_voice_cloning": true,
    "can_use_professional_voice_cloning": true,
    "character_count": 17231,
    "character_limit": 100000,
    "character_refresh_period": "monthly_period",
    "currency": "usd",
    "current_overage": {
      "amount": "0",
      "currency": "usd"
    },
    "max_character_limit_extension": 10000,
    "max_credit_limit_extension": 10000,
    "max_voice_add_edits": 230,
    "next_character_count_reset_unix": 1738356858,
    "professional_voice_limit": 1,
    "professional_voice_slots_used": 0,
    "professional_voice_slots_used_in_workspace": 0,
    "status": "free",
    "tier": "trial",
    "voice_add_edit_counter": 212,
    "voice_limit": 120,
    "voice_slots_used": 1
  },
  "user_id": "1234567890",
  "xi_api_key": "8so27l7327189x0h939ekx293380l920"
}