リードを検索する
このピースでできることferret Oneの接続方法ピースの設定項目1. メールアドレス（任意）2. 更新日時 から（任意）3. 更新日時 まで（任意）4. その他の項目（任意／配列）5. カスタム項目（任意／オブジェクト）6. 失敗時に続ける（任意）7.失敗時に再試行（任意）
このピースでできること
- ferret Oneで条件を組み合わせてリード一覧を取得します。
- メールアドレスや更新日時、標準項目、カスタム項目で絞り込みできます。
ferret Oneの接続方法
- 「webhookを受信する」のピースではAPI keyは不要です。
- ferret OneのAPI管理画面のサイドバーから 設定・管理>外部連携設定>API/他 を選択する。画面真ん中の「APIキーを作成」をクリックします。
- API keyの名前をつけます。
- API keyが表示されるのでメモします。二度と表示されないのでメモを忘れないようにしてください。
- workrunのferret Oneピースの接続でAPI keyを貼り付ける。
ピースの設定項目
1. メールアドレス（任意）
- 部分一致で検索します。
- 具体的なメールアドレスの一部や全体をご入力ください。
2. 更新日時 から（任意）
- この日時以降に更新されたリードを対象にします。
- 日時は「YYYY-MM-DD HH:MM:SS」形式で入力してください。
3. 更新日時 まで（任意）
- この日時以前に更新されたリードを対象にします。
- 日時は「YYYY-MM-DD HH:MM:SS」形式で入力してください。
4. その他の項目（任意／配列）
- 標準項目の条件を配列で追加できます。
- 項目名(fieldType)と値(fieldName)をセットで指定します。
- 例：都道府県、取得データ上限(limit)、ページ(page)など。
- セグメント ID, セグメント追加日時(開始), セグメント追加日時(終了)も指定できます。
- パラメータ一覧
| パラメータ | 説明 | 検索タイプ | 入力形式 | 備考 |
|---|---|---|---|---|
| send_mail_active | メール配信設定ON | 完全一致 | trueまたはfalse | |
| メールアドレス | 部分一致 | |||
| sales_person_name | 営業担当者 | 部分一致 | ||
| sales_person_email | 営業担当者メールアドレス | 部分一致 | ||
| import_from | 種別 | 部分一致 | ||
| position | 役職 | 部分一致 | ||
| department | 部署名 | 部分一致 | ||
| address | 都道府県 | 部分一致 | ||
| region | 地域 | 部分一致 | ||
| custom_field | カスタム項目 | 部分一致 | チェックボックスに対して配列形式で指定したい場合、|で文字を区切って入力 e.g. りんご|みかん | OR検索可能 |
| labels | ラベル | 完全一致 | |で文字を区切って入力 e.g. りんご|みかん | OR検索可能 |
| created_from | 登録日時 から | - | 日付形式 e.g. | 日付形式以外ならエラー |
| created_to | 登録日時 まで | - | 日付形式 e.g. | 日付形式以外ならエラー |
| updated_from | 更新日時 から | - | 日付形式 e.g. | 日付形式以外ならエラー |
| updated_to | 更新日時 まで | - | 日付形式 e.g. | 日付形式以外ならエラー |
| segment_id | セグメントID | 完全一致 | ||
| segment_joined_from | セグメント追加日時 から | - | 日付形式 e.g. | 日付形式以外ならエラー |
| segment_joined_to | セグメント追加日時 まで | - | 日付形式 e.g. | 日付形式以外ならエラー |
| limit | 取得データ上限 | - | 1~100までの整数 | デフォルトは50、1〜100まで指定可能、指定範囲外または数値以外ならエラー |
| page | 取得データページ | - | 1以上の整数 | デフォルトは1、数字以外ならエラー |
| sort | データの並び順 | - | created_atかupdated_at | デフォルトはcreated_at、created_atかupdaetd_atを指定、それ以外はエラー |
| order | 昇順 / 降順 | - | ASCかDESC | デフォルトはASC、ASCかDESCを指定、それ以外はエラー |
5. カスタム項目（任意／オブジェクト）
- カスタムフィールドで絞り込みます。
- キーに項目名、値に検索値を入れてください。
6. 失敗時に続ける（任意）
- このオプションを有効にすると、このステップをスキップし、失敗した場合は正常にフローを継続します。
7.失敗時に再試行（任意）
- 失敗したときに自動的に最大 4 回の試行を再試行します。