API docs by Redocly

List Finder API (1.0.0)

Download OpenAPI specification:Download

List Finder APIとは

List Finder APIでは簡単なリクエストとレスポンスの例を以下に説明します。

このチュートリアルでは、List Finder APIを使用して必要なデータを取得し、当社のアプリケーションとの統合を開発するための基本的な方法を学び、理解することができます。 左側のドロップダウンメニューからセクションを選択し、目的のエンドポイントを検索することができます。 リクエストパラメータの概要を見つけることができ、Curlを使ったアクセス方法、プログラミング言語でアクセスするサンプルを記載しています。

認証

access-tokenの取得

emailとpasswordをリクエストパラメーターに指定し、ログインに成功するとJWT認証済みのaccess-tokenを取得します。

Request Body schema: application/json
email
required
string

ListFinderにログインするメールアドレスを指定してください。

password
required
password

ListFinderにログインするパスワードを指定してください。

Responses

Request samples

Content type
application/json
{
  • "email": "taro@innovation.co.jp",
  • "password": "XXXXXX"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV2QiLC2hbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sYXJhdmVsLXRha2FzYW45ODkuYzl1c2Vygy5pb1wvYXBpXC9sb2dpbiIsImlhdCI6MTUyMjE1NTY1OSwiZXhwIjoxNTIyMTU5MjU5xCJuYmYiOjE1MxIxNTU2NTksImp0aSI6Inh6MHRsQ1hHNmgwQ1g3V0UiLCJzdWIiOjEsInBydiI6Ijg3bTBhZjFlZjlmZDE1ODEyZmorYzk3MTUzYTE0ZTBJfDQ3NTQ2YWEifQ.BdoHaKFy8XLOSaTKBOhA1D3i5NPUGzG9E1lsBQefEhs",
  • "token_type": "bearer",
  • "expires_in": 3600
}

認証ユーザーの取得

access-tokenパラメーターに指定し、認証済みの場合は新しいaccess-tokenを取得しログインユーザーの情報を返却します。

Responses

Request samples 

curl -H "Content-Type: application/json" -H "Authorization: Bearer <access-token>" "https://api-user.list-finder.jp/api/authorize/me"

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV2QiLC2hbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sYXJhdmVsLXRha2FzYW45ODkuYzl1c2Vygy5pb1wvYXBpXC9sb2dpbiIsImlhdCI6MTUyMjE1NTY1OSwiZXhwIjoxNTIyMTU5MjU5xCJuYmYiOjE1MxIxNTU2NTksImp0aSI6Inh6MHRsQ1hHNmgwQ1g3V0UiLCJzdWIiOjEsInBydiI6Ijg3bTBhZjFlZjlmZDE1ODEyZmorYzk3MTUzYTE0ZTBJfDQ3NTQ2YWEifQ.BdoHaKFy8XLOSaTKBOhA1D3i5NPUGzG9E1lsBQefEhs",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "email": "taro@innovation.co.jp",
  • "user_name_first": "太郎",
  • "user_name_last": "山田",
  • "user_name_first_kana": "タロー",
  • "user_name_last_kana": "ヤマダ",
  • "last_login_at": "2023/04/01 20:15:03"
}

access-tokenの無効化

access-tokenパラメーターに指定し、認証済みのaccess-tokenを無効化します。

Responses

Request samples 

curl -H "Content-Type: application/json" -H "Authorization: Bearer <access-token>" "https://api-user.list-finder.jp/api/authorize/revoke"

Response samples

Content type
application/json
{
  • "message": "The token has been successfully revoked."
}

個人マスタ

個人マスタ一覧情報の取得

リクエストパラメーターにlimitとoffsetを指定できます。取得できる最大のlimitは1000件です。 検索結果が0件の場合は200ステータスを返却します。

query Parameters
limit
integer

クエリパラメーターにlimitを指定した場合、そのlimitのデータ数を取得します。

offset
integer

クエリパラメーターにoffsetを指定した場合、開始位置を指定して取得します。

sort
any
Enum: "asc" "desc"

クエリパラメーターにsortを指定した場合idの昇順または降順で取得します。指定しない場合は降順で取得されます。

header Parameters
Authorization
required
string
Value: "Bearer <access-token>"

Responses

Request samples 

curl -H "Authorization: Bearer <access-token>" "https://api-user.list-finder.jp/api/person_list?limit=1000&offset=0"

Response samples

Content type
application/json
{
  • "person_count": 12345,
  • "person_list": [
    ]
}

個人マスタ情報の取得

リクエストパラメーターのpersonal_idまたはsalesforce_idまたはkintone_idから個人マスタ情報を取得します。 複数のパラメーターを指定した場合は前者が有効となり、後者のパラメーターは評価しません。 いずれも指定しない場合や検索結果が取得できない場合は404になります。 ※検索結果が取得できない場合、パラメーターにメールアドレスが含まれている場合はメールアドレスをキーに個人マスタ情報を取得します。

query Parameters
personal_id
integer

クエリパラメーターにpersonal_idを指定した場合、個人マスタIDをキーに個人マスタ情報を取得します。

salesforce_id
string

クエリパラメーターにsalesforce_idを指定した場合、salesforce_idをキーに個人マスタ情報を取得します。

kintone_id
integer

クエリパラメーターにkintone_idを指定した場合、kintone_idをキーに個人マスタ情報を取得します。

header Parameters
Authorization
required
string
Value: "Bearer <access-token>"

Responses

Request samples 

curl -H "Content-Type: application/json" -H "Authorization: Bearer <access-token>" "https://api-user.list-finder.jp/api/person?personal_id={personal_id}"

Response samples

Content type
application/json
{
  • "personal_id": 12345,
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "client_id": 12345,
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB",
  • "person_user": "佐藤 二郎",
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。\n改行です。 ",
  • "mail_unacceptance_flag": false,
  • "mail_unacceptance_text": "登録あり (個別登録) ",
  • "tracking_accept_flag": true,
  • "tracking_accept_text": "同意",
  • "created_at": "2023-12-01T01:23:45",
  • "created_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "modified_at": "2023-12-01T01:23:45",
  • "modified_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "updated_at": "2023-12-01T01:23:45"
}

個人マスタ情報の更新

リクエストパラメーターのpersonal_idまたはsalesforce_idまたはkintone_idから個人マスタ情報を更新します。 数のパラメーターを指定した場合は前者が有効となり、後者のパラメーターは評価しません。 いずれも指定しない場合や検索結果が取得できない場合は404になります。 ※検索結果が取得できない場合、パラメーターにメールアドレスが含まれている場合はメールアドレスをキーに個人マスタ情報を更新します。

query Parameters
personal_id
integer

クエリパラメーターにpersonal_idを指定した場合、個人マスタIDをキーに個人マスタ情報を更新します。

salesforce_id
string

クエリパラメーターにsalesforce_idを指定した場合、salesforce_idをキーに個人マスタ情報を更新します。

kintone_id
integer

クエリパラメーターにkintone_idを指定した場合、kintone_idをキーに個人マスタ情報を更新します。

header Parameters
Authorization
required
string
Value: "Bearer <access-token>"
Request Body schema: application/json
email
string

メールアドレス（メールアドレス形式であること、重複の場合はエラー（400））

related_key
string

連携キー（重複の場合はエラー（400））

salesforce_id
string

salesforceの個人ID（重複の場合はエラー（400））

kintone_id
integer

kintoneの個人ID（重複の場合はエラー（400））

person_status
string

個人ステータスのテキスト（ListFinderに登録されていない場合はエラー（400））

person_tags
string

個人タグのテキスト（「,」または「;」を区切り文字とし、 ListFinderに登録されていない場合は個人タグを作成します）

person_user
string

担当者のテキスト（ListFinderに登録されていない場合はエラー（400））

mail_unacceptance_flag
boolean

配信除外登録（true: 配信除外登録 false: 配信）（指定しない場合はfalse）

person_name_first
string

氏名(名)

person_name_last
string

氏名(姓)

person_name_first_kana
string

氏名カナ(名)

person_name_last_kana
string

氏名カナ(姓)

company_name
string

会社名

company_name_kana
string

会社名カナ

division_only
string

部署

division_name
string

役職

tel_1
string

電話1(個人)

tel_2
string

電話2(個人)

mobile
string

携帯電話

fax_1
string

FAX(個人)

zip_code
string

郵便番号

address_prefecture
string

都道府県のテキスト 例：（東京都、北海道、埼玉県）

address
string

市区町村以下

address_building
string

ビル名

web_url_1
string

URL（URL形式）

free_1
string

自由項目1

free_2
string

自由項目2

free_3
string

自由項目3

free_4
string

自由項目4

free_5
string

自由項目5

memo
string

メモ

Responses

Request samples

Content type
application/json
{
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB または 個人タグA;個人タグB",
  • "person_user": "佐藤 二郎",
  • "mail_unacceptance_flag": false,
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。"
}

Response samples

Content type
application/json
{
  • "personal_id": 12345,
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "client_id": 12345,
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB",
  • "person_user": "佐藤 二郎",
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。\n改行です。 ",
  • "mail_unacceptance_flag": false,
  • "mail_unacceptance_text": "登録あり (個別登録) ",
  • "tracking_accept_flag": true,
  • "tracking_accept_text": "同意",
  • "created_at": "2023-12-01T01:23:45",
  • "created_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "modified_at": "2023-12-01T01:23:45",
  • "modified_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "updated_at": "2023-12-01T01:23:45"
}

個人マスタ情報の登録

個人マスタ情報を登録します。

header Parameters
Authorization
required
string
Value: "Bearer <access-token>"
Request Body schema: application/json
email
string

メールアドレス（メールアドレス形式であること、重複の場合はエラー（400））

related_key
string

連携キー（重複の場合はエラー（400））

salesforce_id
string

salesforceの個人ID（重複の場合はエラー（400））

kintone_id
integer

kintoneの個人ID（重複の場合はエラー（400））

person_status
string

個人ステータスのテキスト（ListFinderに登録されていない場合はエラー（400））

person_tags
string

個人タグのテキスト（「,」または「;」を区切り文字とし、 ListFinderに登録されていない場合は個人タグを作成します）

person_user
string

担当者のテキスト（ListFinderに登録されていない場合はエラー（400））

mail_unacceptance_flag
boolean

配信除外登録（true: 配信除外登録 false: 配信）（指定しない場合はfalse）

person_name_first
string

氏名(名)

person_name_last
string

氏名(姓)

person_name_first_kana
string

氏名カナ(名)

person_name_last_kana
string

氏名カナ(姓)

company_name
string

会社名

company_name_kana
string

会社名カナ

division_only
string

部署

division_name
string

役職

tel_1
string

電話1(個人)

tel_2
string

電話2(個人)

mobile
string

携帯電話

fax_1
string

FAX(個人)

zip_code
string

郵便番号

address_prefecture
string

都道府県のテキスト 例：（東京都、北海道、埼玉県）

address
string

市区町村以下

address_building
string

ビル名

web_url_1
string

URL（URL形式）

free_1
string

自由項目1

free_2
string

自由項目2

free_3
string

自由項目3

free_4
string

自由項目4

free_5
string

自由項目5

memo
string

メモ

Responses

Request samples

Content type
application/json
{
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB または 個人タグA;個人タグB",
  • "person_user": "佐藤 二郎",
  • "mail_unacceptance_flag": false,
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。"
}

Response samples

Content type
application/json
{
  • "personal_id": 12345,
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "client_id": 12345,
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB",
  • "person_user": "佐藤 二郎",
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。\n改行です。 ",
  • "mail_unacceptance_flag": false,
  • "mail_unacceptance_text": "登録あり (個別登録) ",
  • "tracking_accept_flag": true,
  • "tracking_accept_text": "同意",
  • "created_at": "2023-12-01T01:23:45",
  • "created_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "modified_at": "2023-12-01T01:23:45",
  • "modified_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "updated_at": "2023-12-01T01:23:45"
}

個人マスタ情報の登録/更新

個人マスタ情報のupsertを行います リクエストパラメーターのpersonal_idまたはsalesforce_idまたはkintone_idから個人マスタ情報を更新（update）します。 複数のパラメーターを指定した場合は前者が有効となり、後者のパラメーターは評価しません。 いずれも指定しない場合や検索結果が取得できない場合は登録（insert）をします。

query Parameters
personal_id
integer

クエリパラメーターにpersonal_idを指定した場合、個人マスタIDをキーに個人マスタ情報を更新し取得できない場合は登録します。

salesforce_id
string

クエリパラメーターにsalesforce_idを指定した場合、salesforce_idをキーに個人マスタ情報を更新し取得できない場合は登録します。

kintone_id
integer

クエリパラメーターにkintone_idを指定した場合、kintone_idをキーに個人マスタ情報を更新し取得できない場合は登録します。

header Parameters
Authorization
required
string
Value: "Bearer <access-token>"
Request Body schema: application/json
email
string

メールアドレス（メールアドレス形式であること、重複の場合はエラー（400））

related_key
string

連携キー（重複の場合はエラー（400））

salesforce_id
string

salesforceの個人ID（重複の場合はエラー（400））

kintone_id
integer

kintoneの個人ID（重複の場合はエラー（400））

person_status
string

個人ステータスのテキスト（ListFinderに登録されていない場合はエラー（400））

person_tags
string

個人タグのテキスト（「,」または「;」を区切り文字とし、 ListFinderに登録されていない場合は個人タグを作成します）

person_user
string

担当者のテキスト（ListFinderに登録されていない場合はエラー（400））

mail_unacceptance_flag
boolean

配信除外登録（true: 配信除外登録 false: 配信）（指定しない場合はfalse）

person_name_first
string

氏名(名)

person_name_last
string

氏名(姓)

person_name_first_kana
string

氏名カナ(名)

person_name_last_kana
string

氏名カナ(姓)

company_name
string

会社名

company_name_kana
string

会社名カナ

division_only
string

部署

division_name
string

役職

tel_1
string

電話1(個人)

tel_2
string

電話2(個人)

mobile
string

携帯電話

fax_1
string

FAX(個人)

zip_code
string

郵便番号

address_prefecture
string

都道府県のテキスト 例：（東京都、北海道、埼玉県）

address
string

市区町村以下

address_building
string

ビル名

web_url_1
string

URL（URL形式）

free_1
string

自由項目1

free_2
string

自由項目2

free_3
string

自由項目3

free_4
string

自由項目4

free_5
string

自由項目5

memo
string

メモ

Responses

Request samples

Content type
application/json
{
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB または 個人タグA;個人タグB",
  • "person_user": "佐藤 二郎",
  • "mail_unacceptance_flag": false,
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。"
}

Response samples

Content type
application/json
{
  • "personal_id": 12345,
  • "salesforce_id": "01AA0000000001ABCD",
  • "kintone_id": 12345,
  • "client_id": 12345,
  • "email": "taro@innovation.co.jp",
  • "related_key": "xxxxxx",
  • "person_status": "営業中",
  • "person_tags": "個人タグA,個人タグB",
  • "person_user": "佐藤 二郎",
  • "person_name_first": "太郎",
  • "person_name_last": "山田",
  • "person_name_first_kana": "タロー",
  • "person_name_last_kana": "ヤマダ",
  • "company_name": "株式会社イノベーション",
  • "company_name_kana": "カブシキカイシャイノベーション",
  • "division_only": "開発部",
  • "division_name": "部長",
  • "tel_1": "03-1234-1234",
  • "tel_2": "03-1234-1234",
  • "mobile": "090-1234-1234",
  • "fax_1": "03-1234-1234",
  • "zip_code": "150-0002",
  • "address_prefecture": "東京都",
  • "address": "渋谷区渋谷3丁目10−13",
  • "address_building": "LFビル",
  • "web_url_1": "https://promote.list-finder.jp",
  • "free_1": "自由項目1",
  • "free_2": "自由項目2",
  • "free_3": "自由項目3",
  • "free_4": "自由項目4",
  • "free_5": "自由項目5",
  • "memo": "これはメモです。\n改行です。 ",
  • "mail_unacceptance_flag": false,
  • "mail_unacceptance_text": "登録あり (個別登録) ",
  • "tracking_accept_flag": true,
  • "tracking_accept_text": "同意",
  • "created_at": "2023-12-01T01:23:45",
  • "created_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "modified_at": "2023-12-01T01:23:45",
  • "modified_at_text": "2023/12/01 01:23:45（ユーザー名）",
  • "updated_at": "2023-12-01T01:23:45"
}