API_USE_0101_ユーザ一覧取得¶

概要¶

システムに登録されたユーザの一覧を取得する。

リクエスト¶

HTTPリクエスト¶

HTTPメソッド	URL
GET	/api/users

パスパラメーター¶

なし

クエリパラメーター¶

なし

リクエストボディ¶

なし

レスポンス¶

200 OK¶

レスポンスサンプル
{
  "users": [
    {
      "userId": "01D0KDBRASGD5HRSNDCKA0AH53",
      "name": "佐藤太郎",
      "nameKana": "さとうたろう"
    },
    {
      "userId": "01D0KDBRASGD5HRSNDCKA0AH61",
      "name": "佐藤次郎",
      "nameKana": "さとうじろう"
    }
  ]
}

変数名	型	必須	論理名	形式
users	array(obj)	✅	お気に入り一覧
users > userId	string	✅	ユーザID	ULID形式
users > name	string	✅	ユーザ名
users > nameKana	string	✅	ユーザ名(かな)

エラーレスポンス¶

500 Internal Server Error¶

err_code	err_message
E5001	Failed to auth server.