名刺一覧取得(条件指定)

このピースでできること

  • 会社名や氏名などの条件を指定して、Sansanの名刺を検索して一覧を取得します。
 

Sansan の接続方法

Sansan の管理画面から発行した API キーを入力して接続します。

API キーの取得手順

  1. Sansan に管理者としてログインします
  1. 右上のメニューから 管理者設定 を開きます
  1. API キー のメニューを開きます
  1. 「API キーを発行する」 をクリックします
  1. 発行された API キーをコピーし、接続画面の 「API キー」 欄に貼り付けます

ピースの設定項目

1. 会社名(任意)

  • Sansanに登録されている会社名を、部分一致で検索するための条件です。
  • 会社名で絞り込みたい場合に入力してください。

2. 氏名(任意)

  • Sansanに登録されている氏名を、前方一致で検索するための条件です。
  • 姓のみで検索したい場合も入力できます。

3. メールアドレス(任意)

  • Sansanに登録されているメールアドレスを、完全一致で検索するための条件です。
  • 1件に絞り込みたい場合に有効です。

4. 電話番号(任意)

  • Sansanに登録されている電話番号を、部分一致で検索するための条件です。
  • 市外局番の一部などでも検索できます。

5. 携帯番号(任意)

  • Sansanに登録されている携帯番号を、部分一致で検索するための条件です。

6. その他の項目(任意)

指定できる項目名と設定値の一覧です。
  • 所有者の範囲) 自分以外の名刺も取得したい場合に使用します。 を指定するとすべてのユーザーの名刺が取得できます。
  • 次ページ取得用トークン) 前回の取得結果に含まれるトークンを指定すると、続きのページを取得できます。
  • タグ情報を含める) 名刺に紐づくタグ情報を結果に含めたい場合は  を指定します。
  • 過去の名刺情報を含める) 過去バージョンの名刺情報も結果に含めたい場合は  を指定します。
  • タグID) 特定のタグが付いた名刺のみ取得したい場合にタグIDを指定します。複数指定する場合は  で区切ります(例:)。
  • 名刺入力状態) 名刺の入力状態で絞り込みます。(入力中)・(入力済み)・(判読不能)から指定できます。複数指定する場合は  で区切ります。
  • 並び替え項目) 並び替えの基準となる項目名を指定します。
  • 並び順) 並び順を (昇順)または (降順)で指定します。
  • 取得上限) 1回のリクエストで取得する件数の上限を数値で指定します。