API リファレンス
GET /lists/candidates
estimate から保存前の candidate preview を取得する endpoint です。
このページの内容9項目
GET /api/signal-foundry/lists/candidates は、estimate_id から保存前の候補 preview を返します。preview は無料ですが、saved List ではないため export できません。
契約サマリー
| Field | Value |
|---|---|
| Method | GET |
| Path | /api/signal-foundry/lists/candidates |
| Auth | production は API key 必須 |
| Usage | request usage に count |
| Credit | 消費しない |
| CLI | sf list candidates --from-estimate <estimateId> --json |
リクエスト
クエリパラメータ
| Param | Type | Notes |
|---|---|---|
estimate_id | string | POST /lists/estimate が返した id |
limit | number | optional。preview 件数 |
例
curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/candidates?estimate_id=est_123" \ -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>"
CLI equivalent:
sf list candidates --from-estimate est_123 --json
レスポンス
中心フィールド
estimate.estimate_idcompanies[]companies[].company_id_hintcompanies[].company_hintcompanies[].reasonmeta.candidate_preview_onlymeta.exportable
例
{
"estimate": {
"estimate_id": "est_123",
"definition_hash": "def_abc",
"expires_at": "2026-05-01T12:00:00.000Z"
},
"companies": [
{
"company_id_hint": "jpx_7203",
"company_hint": "Toyota Motor",
"listing_status": "listed",
"market_segment": "prime",
"reason": "Matched revenue threshold and listed status"
}
],
"meta": {
"candidate_preview_only": true,
"exportable": false,
"preview_is_free": true,
"returned_companies": 1
}
}
エラー
| Code | HTTP | 復旧方法 |
|---|---|---|
estimate_not_found | 404 | POST /lists/estimate から再実行 |
invalid_query | 400 | estimate_id を付ける |
preview_export_not_allowed | 400 | saved List にしてから export |
次に進む
保存する場合は POST /lists/materialize に進みます。保存しない探索なら、この preview を見て query を修正します。