本文へ移動
Bounty Developer

GET/api/v1/boshu/calls/{id}/questionnaire

「BOSHU の外部 API」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

募集の設問（ページ・モジュール・質問・固定した revision・棚の新しい版の有無・hash・MCP で当てられる範囲）。応募者の情報は件数だけ

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • idpath必須string(uuid)

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

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

  • callIdstring(uuid)
  • titlestring
  • status"draft" | "published" | "closed"
  • approval"not_required" | "pending" | "approved" | "rejected"
  • policy"all_operations" | "no_new_version"
  • versioninteger | null
  • hashstring/^[0-9a-f]{64}$/
  • pageobject
    • idstring
    • destinationstring
    • placementstring
    • titlestring
    • modulesarray<object | object>
      • |1object
        • kind"shared"
        • idstring
        • moduleIdstring
        • pinned任意object
          • revisioninteger
          • bodyobject
            • titlestring
            • helpstring | null
            • questionsarray<object>
      • |2object
        • kind"inline" | "legacy"
        • idstring
        • bodyobject
          • titlestring
          • helpstring | null
          • questionsarray<object>
            • idstring
            • typestring
            • labelstring
  • placedarray<object>
    • refIdstring
    • moduleIdstring
    • revisioninteger | null
    • shelfRevisioninteger | null
    • outdatedboolean
    • archivedboolean
  • applicationCountinteger≥0
  • shelveTargetsobject
    • eventboolean
    • platformboolean

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • invalid_token
  • forbidden
  • consent_required
  • rate_limited
  • call_not_found

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/v1/boshu/calls/{id}/questionnaire" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/v1/boshu/calls/{id}/questionnaire | Bounty Developer