BaaS@rakuza ドキュメント

ユーザー情報一覧取得API

指定されたパラメーターでユーザー情報を一覧取得する。

メソッド

POST

パス

/user/list

リクエストボディ

Name型概要
tenant_id(必須)文字列テナントID
※別途お渡しした内容をご利用ください。
contents.search_conditionオブジェクト検索条件
※取得対象の顧客検索条件を指定してください。
contents.order_conditionオブジェクトソート条件
※取得結果の並び順を指定してください。
contents.limit数値取得する件数の上限数
contents.offset数値取得開始位置

レスポンスボディ

Name型概要
status(必須)文字列ステータスコード
message(必須)文字列実行メッセージ
contents.result_cnt数値取得したユーザー一覧の件数
contents.user_info配列取得したユーザー情報の一覧配列
contents.detail_message文字列、配列エラーメッセージ

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "result_cnt":2
    "user_info": [
      {
        "user_no": "APP00001",
        "user_id": "210010000000001",
        "user_name": "ピープルテスト",
        "age_config": "0001",
        "age_config_name": "10代",
        "join_dte": "2024-01-01",
        "update_date": "2024-01-01 00:00:00",
        "user_sample_image": "123456789.jpg",
        "user_sample_image_url": "https://test.raku-za.jp/apps/test/Image/users/123456789.jpg"
      },
      {
        "user_no": "APP00002",
        "user_id": "210010000000002",
        "user_name": "ピープルテスト２",
        "age_config": "0002",
        "age_config_name": "20代",
        "join_dte": "2024-01-01",
        "update_date": "2024-01-01 00:00:00",
        "user_sample_image": "123456789.jpg",
        "user_sample_image_url": "https://test.raku-za.jp/apps/test/Image/users/123456789.jpg"
      }
    ]
  }
}