本文へ移動
Bounty Developer

GET/api/boshu/calls/{id}/embedded

「BOSHU」の分類の、情報を読み出す API。募集の埋め込みフォームの許可（トークン）を付けて呼ぶ。

要約

募集専用iframe認可で本人フォームを取得。cookie/Bearer不可、毎回本人/規約/公開状態を確認

呼び方と印

トークン（募集の埋め込み）

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

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

  • idpath必須string(uuid)
  • applicantOrgIdquery任意string(uuid)

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

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

  • callobject
    • idstring
    • thumbnailUrl任意string
    • hasKeyVisual任意boolean
    • applicantKind任意"individual" | "guild" | "venture"
    • groupSubmissionPolicy任意"managers" | "confirmed_members"
    • template任意string | null
    • profilePolicy任意"kind" | "basic" | "required"
    • portfolioRequired任意boolean
    • mode任意"review" | "first_come"
    • applicationFields任意object | null
      • headline任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • message任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • links任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
      • portfolio任意object
        • enabledboolean
        • requiredboolean
        • labelstring長さ 1–120
        • placeholderstring長さ ≤200
    • messagePolicy任意"legacy" | "required" | "optional" | "off"
    • audience"all" | "student" | "professional"
    • kind"staff" | "talk" | "pitch" | "other"
    • kindLabelstring
    • titlestring
    • descriptionstring | null
    • requirementsstring | null
    • capacityinteger | null
    • remaininginteger | null
    • remainingLabelstring
    • talkMinutesinteger | null
    • opensAtstring
    • closesAtstring
    • phase"hidden" | "upcoming" | "open" | "closed"
    • closingSoonboolean
    • countdownstring
    • paidboolean
    • compensationstring | null
    • ribbonLabelstring | null
    • sessionobject | null
      • idstring
      • titlestring
      • startsAtstring
      • durationMininteger
      • dayLabelstring
      • rangestring
      • roomNamestring | null
    • questionCountinteger
    • mineobject | null
      • applicantOrg任意object | null
        • kind"guild" | "venture"
        • idstring
        • namestring
        • logoUrlstring | null
      • idstring
      • callIdstring
      • headlinestring | null
      • messagestring
      • linksarray<object>
        • urlstring
        • labelstring | null
      • portfolioItemIdsarray<string>
      • answersrecord<string | array<string> | boolean>
      • statusobject
        • kindenum(5)"pending" "accepted" "waitlisted" "rejected" "withdrawn"
        • labelstring
        • positioninteger | null
      • canWithdrawboolean
      • canEditboolean
      • inSelectionboolean
      • createdAtstring
      • updatedAtstring
    • ownerobject
      • kindenum(5)"platform" "event" "guild" "venture" "person"
      • idstring | null
      • namestring
      • hrefstring | null
    • questionsarray<object>
      • maxLength任意integer
      • section任意string
      • organizationField任意enum(11)"name" "nameKana" "organizationType" "baseUniversities" "foundedYearMonth" "memberCount" "studentMemberCount" "genres" "links" "catchphrase" "activitySummary"
      • profileField任意enum(9)"displayName" "title" "orgName" "schoolName" "gradYear" "organizations" "faculty" "standing" "grade"
      • memberSelection任意object
        • kind"active_student"
        • min1
        • max3
      • condition任意object
        • questionIdstring
        • optionIdstring
      • idstring
      • typeenum(9)"short" "long" "single" "multi" "check" "url" "date" "image" "document"
      • labelstring
      • helpstring | null
      • requiredboolean
      • enabled任意boolean
      • optionsarray<object>
        • idstring
        • labelstring
      • sensitiveboolean
    • questionSetIdstring
  • prefillobject
    • viewerId任意string
    • organization任意object
      • idstring
      • kind"guild" | "venture"
      • updatedAtstring | null
      • lockedQuestionIdsarray<string>
      • summarizeQuestionIds任意array<string>
    • profileFields任意object
      • quotedQuestionIdsarray<string>
      • writableQuestionIdsarray<string>
    • applicants任意array<object>
      • kind"guild" | "venture"
      • idstring
      • namestring
      • logoUrlstring | null
    • profileobject
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • catchphrasestring | null
      • links任意record<string>
    • viewerProfile任意object
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • catchphrasestring | null
      • links任意record<string>
    • matchedOnly任意boolean
    • readyboolean
    • gateboolean
    • draftobject
      • applicantOrgId任意string | null
      • headlinestring | null
      • messagestring
      • linksarray<object>
        • urlstring
        • labelstring | null
      • portfolioItemIdsarray<string>
      • answersrecord<string | array<string> | boolean>
      • from"mine" | "previous" | "profile" | "empty"
    • portfolioobject
      • statestring
      • itemsarray<object>
        • idstring
        • titlestring
        • urlstring
        • kindstring
        • coverstring | null
        • metastring
        • hasMaterial任意boolean
        • description任意string
        • entryType任意"work" | "lightning_talk"
        • format任意string
        • tools任意array<string>
        • technicalDetails任意record<array<string>>
        • technicalNote任意string
        • attachment任意object
          • kind"pdf"
          • urlstring
    • audience任意object | object
      • |1object
        • audience"student" | "professional"
        • state"missing" | "correctable"
        • fieldsarray<enum(6)>
        • initialobject
          • enrollmentStatusenum(5)"active" "on_leave" "graduated" "withdrawn" "unknown"
          • gradYearinteger | null
          • gradMonth任意integer | null
          • schoolNamestring | null
        • upfrontboolean
      • |2object
        • audience"student" | "professional"
        • state"ineligible"
        • upfrontboolean

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/boshu/calls/{id}/embedded" \
  -H "X-Boshu-Grant: $BOSHU_GRANT" \
  -H "X-Boshu-Proof: $BOSHU_PROOF"
GET /api/boshu/calls/{id}/embedded | Bounty Developer