本文へ移動
Bounty Developer

GET/api/me/referral/tree

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

要約

自分の紹介の木（上の代と下の代の一部）

呼び方と印

ログイン

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

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

  • entryIdquery任意string
    長さ 1–200
  • focusEntryIdquery任意string(uuid)
  • cursorquery任意string
    /^[A-Za-z0-9_-]{1,2048}$/

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

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

  • treeobject | null
  • ancestorsarray<object>
    • namestring
    • disabledboolean
    • foursUserIdstring | null
    • entryId任意string | null
  • truncatedboolean
  • treeUrlstring | null
  • entryId任意string | null
  • focusEntryId任意string | null

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 502HTTP 502（x-bounty-error-codes を参照）
  • 503HTTP 503（x-bounty-error-codes を参照）
  • invalid_input
  • referral_tree_not_owned
  • referral_tree_not_found
  • referral_cursor_invalid
  • referral_not_configured
  • fours_reconnect_required
  • referral_unavailable

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/me/referral/tree" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/me/referral/tree | Bounty Developer