Skip to main content
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}$

レスポンス

取得成功

コンタクト活動の単一レコード表現。ContactActivity に要約(summaries)を加えたもの。 取得 / 作成 / 更新の応答で返る(一覧・検索では返らない)。

id
string
必須

Stockwork record_id(18 文字)

例:

"Ca7XkQpYz3Lh9vMs2N"

properties
object
必須

活動のプロパティ集合。contact_id(親コンタクト)・occurred_at・content を中心に、 subject / genre 等のコアフィールドとカスタムプロパティが同じ namespace。

created_at
string<date-time>
必須
updated_at
string<date-time>
必須

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

summaries
object[]
必須

紐づく要約。read-only。未生成時は空配列。