本文へ移動
Bounty Developer

GET/api/v1/boshu/drafts/reference

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

要約

呼び手が今扱える既存の募集(重複の確認用。状態・主体・イベント・質問の版・件数。応募者の情報なし)

呼び方と印

ログイン・レート制限

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

返るもの(応答)200 · application/json

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

  • callsarray<object>件数 ≤200
    • idstring(uuid)
    • titlestring
    • kind"staff" | "talk" | "pitch" | "other"
    • templatestring | null
    • status"draft" | "published" | "closed"
    • phasestring
    • approval"not_required" | "pending" | "approved" | "rejected"
    • editableboolean
    • origin"mcp" | "manual"
    • sourceKeystring | null
    • subjectobject
      • kindenum(5)"platform" "event" "guild" "venture" "person"
      • idstring(uuid) | null
      • namestring
    • eventIdstring(uuid) | null
    • questionVersioninteger
    • questionCountinteger≥0
    • capacityinteger | null
    • countsobject
      • pendinginteger≥0
      • holdinteger≥0
      • acceptedinteger≥0
      • waitlistedinteger≥0
      • rejectedinteger≥0
      • withdrawninteger≥0
    • opensAtstring(date-time)
    • closesAtstring(date-time)
    • updatedAtstring(date-time)
  • truncatedboolean
  • publication"draft_only"

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403HTTP 403(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
  • partner_owner_not_allowed
  • partner_applicant_kind

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/v1/boshu/drafts/reference" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/v1/boshu/drafts/reference | Bounty Developer