本文へ移動
Bounty Developer

GET/api/orgs/ventures/{id}/roster

「学生団体・ベンチャー」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

学生発ベンチャーの名簿の 1 つの組の続き

呼び方と印

ログイン

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • idpath必須string(uuid)
  • groupquery必須string
    /^(?:y[1-4]|master|doctor|alumni|other|c\d{1,3})$/
  • offsetquery任意integer
    0–100000 · 既定 0

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • keystring
  • labelstring
  • totalinteger
  • offsetinteger
  • peoplearray<object>
    • idstring
    • userIdstring | null
    • namestring
    • avatarUrlstring | null
    • substring | null
  • nextOffsetinteger | null

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • org_not_found

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl "https://bounty.spikes.4s.link/api/orgs/ventures/{id}/roster?group=string" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/orgs/ventures/{id}/roster | Bounty Developer