メインコンテンツへスキップ
GET
取引を取得

承認

Authorization
string
header
必須

Stockwork が発行する API キー(sk_ プレフィックス、base62 ランダム ≥ 40 文字)。 キーには 1 つの role(read / analyst / write / admin)が紐付き、 各エンドポイントの必要 role 以上であることが要求される(対応表は info.description 参照)。

パスパラメータ

record_id
string
必須

Stockwork record_id(18 文字英数字)

Pattern: ^[A-Za-z0-9]{18}$

レスポンス

取得成功

取引(Deal)レコード

id
string
必須

Stockwork record_id(18 文字)。クライアントはこの ID を保存して以降の参照に使う。

例:

"Rb7XkQpYz3Lh9vMs2N"

properties
object
必須

取引のプロパティ集合。name は必須。 amount/close_date/stage 等のコアフィールドと、組織別カスタムプロパティが 同じ namespace で扱われる。

リレーションは record_id 文字列で表す。

  • account_id — 商談先の会社(Account)
  • owner_id — 担当ユーザー(User)。GET /v1/users/ で解決する 一覧画面・CSV と同じ項目を読み取り専用で返す(GET /properties/ の is_read_only)。作成・更新で指定すると 400。
  • stage_label / stage_category — stage のラベル(一覧画面・CSV の表示)と区分(open / won / lost)。stage の値は選択肢の作成時に決まりラベルだけ変えられるため、値が意味と食い違うことがある(例: 値 closed_won のラベルが「No Opportunity」で区分が lost)。未設定や選択肢に無い値では null
  • product_name — 商材名。商材名で絞り込める
  • latest_score / latest_score_rank — 最新の完了スコア(38/50 の形)とランク。スコアがなければ null
  • account_name / account_restricted — 会社名。閲覧できない会社は null で account_restricted が true
  • owner_name / created_by_name — 一覧と同じ表示名。組織を離れたメンバーは固定のラベルになる
  • contact_ids — 閲覧できるコンタクトの record_id の配列
  • activity_count / last_activity_at — アクティビティの件数と最終日時
  • pathway_* — 受注確率とヘルス。Pathway が有効な組織にのみ存在する
  • <source_type>_<api_name> — SFA 由来のプロパティ(例: hubspot_J08UB0D3)
created_at
string<date-time>
必須
updated_at
string<date-time>
必須

レコードの値が最後に変わった日時。コアフィールド・カスタムプロパティ・アクティビティ件数などの集計値のいずれかが実際に変わったときに進む。商談ログやメールなどの活動を記録した場合も、それが集計値を動かすためこの日時が進む。同じ値での再保存や、他レコードとの紐付け変更では進まない。