コンテンツにスキップ

ユーザー API

面接官の選択などに使うユーザー一覧。共通規約は API 共通仕様 を参照。

ベースパス: /api/v1/users

メソッド パス 概要 認証 必要ロール
GET / ユーザー一覧取得 必要 -

ユーザー一覧取得

面接官選択等に使用するユーザー一覧を取得する。

URI

GET /api/v1/users

認証要件

Authorization: Bearer <access_token> が必要。ロール制限はない。

クエリパラメータ

フィールド 型 必須 既定値 ルール 説明
page integer - 1 正の整数 ページ番号
limit integer - 20 1〜100 1 ページあたりの件数
sort string - - - createdAt:desc 形式
search string - - - 名前またはメールアドレスの部分一致

リクエスト例

GET /api/v1/users?search=yamada&limit=50

レスポンス(200 OK)

ページネーション付きレスポンス。

{
  "success": true,
  "status": "success",
  "statusCode": 200,
  "timestamp": "2026-01-15T10:00:00.000Z",
  "data": [
    {
      "id": 1,
      "email": "user@example.com",
      "name": "John Doe",
      "picture": "https://example.com/avatar.jpg",
      "role": "member",
      "createdAt": "2026-01-15T09:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "totalCount": 12,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  },
  "path": "/api/v1/users",
  "method": "GET"
}
フィールド 型 説明
id integer ユーザー ID
email string メールアドレス
name string 表示名
picture string | null プロフィール画像 URL
role enum admin / member / viewer
createdAt string(date-time) 登録日時

例外処理

説明 ステータスコード ステータス名
トークンが欠落または無効 401 Unauthorized

注記

  • ユーザーの作成・更新・削除を行う API はない。ユーザーは Google OAuth の初回ログイン時に自動登録され、ロールの変更は現状 DB 直接更新で行う
  • 面接官の追加は、このエンドポイントで得た id を 面接官 API に渡す