本文へ移動
Bounty Developer

GET/api/v1/boshu/{id}/partner/organizations

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

要約

認証済み本人の在籍中団体だけを選べる候補として返す（企画募集では対象種別と応募方針に合う団体だけ・登録済み/応募済みの印付き）。検索語があれば承認済み公開団体の名前を選べない参考として返す（運営権限による他団体検索なし）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)
  • qquery任意string
    長さ ≤200 · 既定 ""

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

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

  • expectedActorIdstring(uuid)
  • organizationsarray<object>件数 ≤200
    • kind"guild" | "venture" | "company"
    • idstring(uuid)
    • namestring
    • slugstring
    • platformApprovalstring
    • eventPartnerRegisteredboolean
    • programmeAppliedboolean
    • missingOrganizationFieldsarray<enum(11)>
    • summarizeOrganizationFields任意array<enum(11)>
  • othersarray<object>件数 ≤20
    • kind"guild" | "venture"
    • idstring(uuid)
    • namestring
    • slugstring
    • claimableboolean
    • claimSourceIdstring(uuid) | null
  • pendingSameName任意boolean

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • invalid_query
  • call_not_found
  • event_partner_call_ambiguous
  • unauthorized

呼び出しの見本

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

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