Skip to main content
POST
商談ログを検索(フィルタ + ソート + ページネーション)

承認

Authorization
string
header
必須

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

ボディ

application/json

検索リクエストの共通 schema。 フィルタ・自由文字列・ソート・ページネーションを一括で受け付ける。

filter_groups
object[]

フィルタグループの配列。グループ間は OR で結合(GUI と同じ意味論)。 グループ内の conditions は AND。最大 10 グループまで。 空配列または省略時は全レコードが対象。

「複数フィールドへの横断キーワード検索」(GUI の検索ボックス相当)も、 複数グループに同じ値の contains 条件を入れて表現できる(search のような 専用フィールドは提供しない)。

Maximum array length: 10
sort_by
string[]

ソート対象のフィールド(複数指定でセカンダリーソート)。 例: ["close_date", "amount"]

sort_order
enum<string>[]

ソート順。sort_by と同じ長さで指定する。 例: ["asc", "desc"]

利用可能なオプション:
asc,
desc
page
integer
デフォルト:1

ページ番号(1 始まり)。 page * page_size が 10,000 を超える指定は 400 で拒否される (深い OFFSET 走査の防止)。全件走査にはリスト GET のカーソルを使う。

必須範囲: x >= 1
page_size
integer
デフォルト:100

1 ページあたりの件数

必須範囲: 1 <= x <= 200

レスポンス

検索成功

results
object[]
必須
paging
object
必須

ページネーション情報