获取用户

获取用户信息

请求头

xi-api-keystring可选

响应

成功响应

user_idstring

用户的唯一标识符。

subscriptionobject

用户订阅详情。

is_onboarding_completedboolean

用户是否已完成入门流程。

is_onboarding_checklist_completedboolean

用户的入门清单是否已完成。

created_atinteger

用户创建时的 Unix 时间戳。如果用户在添加 Unix 时间戳前创建,则为 0。

seat_typeenum

用户的席位类型。

允许的值:
is_new_userbooleanDeprecated

用户是否为新用户。此字段已弃用,将在未来移除。请改用 ‘created_at’。

can_use_delayed_payment_methodsbooleanDeprecated

此字段已弃用,将在未来的主要版本中移除。请改用 subscription.trust_on_invoice_creation。

show_compliance_termsboolean可选默认为 false

是否在引导流程中显示合规条款(服务条款、隐私政策、生物识别同意书)。适用于从营销网站注册的用户。

first_namestring or null可选

用户名字。

is_api_key_hashedboolean可选默认为 false

用户的 API 密钥是否已哈希处理。

xi_api_key_previewstring or null可选

用户 API 密钥的预览。

错误

422
Unprocessable Entity Error