本文へ移動
Bounty Developer

GET/api/companies/drafts/context

「企業ページ」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

下書きできる会社と上限（運営 admin は全社、会社の管理者は自社。公開なし）

呼び方と印

ログイン・レート制限

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

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

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

  • contractVersion"1"
  • actorobject
    • idstring(uuid)
    • staffboolean
  • companiesarray<object>件数 ≤200
    • idstring(uuid)
    • slugstring
    • namestring
    • status"draft" | "published"
    • revisioninteger≥0
    • access"staff" | "company_admin"
  • canCreateCompanyboolean
  • canIssueCompanyInviteboolean
  • limitsobject
    • descriptionMax200
    • memberDraftsPerCall50
    • memberDraftsPerCompany500
    • linkMaxDays30
  • publication"draft_only"

失敗したとき（エラー）

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

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

呼び出しの見本

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

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