ユーザーを取得

ユーザーに関する情報を取得します。

ヘッダー

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