ユーザー

ユーザー

ユーザー検索

GET /api/v1/users HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
page ページ 1
per_page ページ毎の取得数 20 100
{
  "page": 1,
  "per_page": 20
}
Copy

Response

HTTP/1.1 200 OK
{
  "users": [
    {
      "user_code": "0000000001",
      "name": "Aさん"
    },
    {
      "user_code": "0000000002",
      "name": "Bさん"
    }
  ],
  "meta": {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/users?page=2&per_page=20",
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}
Copy

ユーザー詳細取得

GET /api/v1/users/:user_code HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
なし
Copy

Response

HTTP/1.1 200 OK
{
  "user": [
    {
      "user_code": "0000000001",
      "name": "Aさん"
    }
  ],
  "meta": {
  }
}
Copy

自分のユーザー詳細取得

GET /api/v1/user/account HTTP/1.1
Copy

Request

パラメータ 内容 必須 デフォルト値 最大値
なし
Copy

Response

HTTP/1.1 200 OK
{
  "user": [
    {
      "user_code": "0000000001",
      "name": "Aさん"
    }
  ],
  "token": [
    {
      "read_flag": true,
      "write_flag": true,
    }
  ],
  "meta": {
  }
}
Copy