GET/cxtalk/contacts

CXトークの連絡先リストを取得する。

  • 開始/終了日時フィルターで指定できる期間は最大 7 日間。

Authorization

oauth2

Access Token を指定します。 指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

cxtalk
cxtalk.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/cxtalk/contacts

Query Parameters

ParameterTypeDescription
count integer 

取得数


default : 100
minimum : 1
maximum : 500
example : 100
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
searchDateType string 

フィルター日時タイプ
startDateTime、endDateTime を使用する場合に指定。

  • CREATED_TIME : 登録日時
  • MODIFIED_TIME : 更新日時

Allowed values : CREATED_TIME, MODIFIED_TIME
example : CREATED_TIME 
startDateTime string 

開始日時フィルター (YYYY-MM-DDThh:mm:ssTZD)

  • 「+」は「%2B」にエンコードする
  • searchDateType とともに使用する

example : 2026-06-03T10:00:00%2B09:00 
endDateTime string 

終了日時フィルター (YYYY-MM-DDThh:mm:ssTZD)

  • 「+」は「%2B」にエンコードする
  • searchDateType とともに使用する

example : 2026-06-03T11:00:00%2B09:00 
contactTagId string 

CXトーク 連絡先タグ ID


example : ctag2a81-94b6-4642-6903-03aa7977da91 
orderBy string 

ソート対象

  • name : 名前
  • createdTime : 登録日時
  • modifiedTime : 更新日時
    並び順
  • asc : 昇順 (既定)
  • desc : 降順
    ソートフィールドと並び順はスペースで区切る (separator : %20)

example : name%20asc 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

CXトーク 連絡先リストレスポンス

PropertyTypeDescription
contacts array (CxTalkContact) 

CXトーク 連絡先情報

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

CxTalkContact

PropertyTypeDescription
contactId string 

CXトーク 連絡先 ID


readOnly : true 
contactName object (contactName) 

連絡先の名前情報


required 
emails array (ContactEmail) 

メールアドレスリスト


minItems : 0
maxItems : 100 
telephones array (ContactTelephone) 

電話番号リスト


minItems : 0
maxItems : 100 
organizations array (ContactOrganization) 

会社/所属リスト


minItems : 0
maxItems : 100 
events array (ContactEvent) 

誕生日・記念日リスト


minItems : 0
maxItems : 100 
locations array (ContactLocation) 

住所リスト


minItems : 0
maxItems : 100 
messengers array (ContactMessenger) 

SNS リスト


minItems : 0
maxItems : 100 
websites array (ContactWebsite) 

Web サイトリスト


minItems : 0
maxItems : 100 
memo string 

メモ


maxLength : 4000 
contactTagIds array (string) 

CXトーク 連絡先タグリスト


minItems : 0 
inquiryChannels array (CxTalkInquiryChannel) 

問い合わせ経路リスト

  • 問い合わせ経路と、その経路での顧客の名前が含まれる。
  • 問い合わせ経路が複数ある場合には、経路での最初の問い合わせ日時を基準に降順でソートされ、すべての経路が含まれる。

minItems : 0
readOnly : true 
cxtalkAccounts array (CxTalkAccount) 

窓口アカウントリスト


minItems : 0
readOnly : true 
createdTime string 

登録日時 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 
modifiedTime string 

更新日時 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 

contactName

PropertyTypeDescription
firstName string 

名

  • lastName が null の場合には必須

maxLength : 100
nullable : true 
lastName string 

姓

  • firstName が null の場合には必須

maxLength : 100
nullable : true 
phoneticFirstName string 

フリガナ 名


maxLength : 100
nullable : true 
phoneticLastName string 

フリガナ 姓


maxLength : 100
nullable : true 
nickName string 

ニックネーム


maxLength : 100
readOnly : true
nullable : true 
prefix string 

敬称
CXトーク 連絡先リストの取得 および CXトーク 連絡先の検索 では null となる。


maxLength : 100
nullable : true 
suffix string 

呼称
CXトーク 連絡先リストの取得 および CXトーク 連絡先の検索 では null となる。


maxLength : 100
nullable : true 
middleName string 

ミドルネーム
CXトーク 連絡先リストの取得 および CXトーク 連絡先の検索 では null となる。


maxLength : 100
nullable : true 

ContactEmail

PropertyTypeDescription
primary boolean 

代表メールアドレスフラグ

  • リスト内で 1 つのメールアドレスを代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初のメールアドレスが代表メールアドレスとなる。

required 
email string 

メールアドレス


required
maxLength : 256
format : email 

ContactTelephone

PropertyTypeDescription
primary boolean 

代表電話フラグ

  • リスト内で 1 つの電話番号を代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初の電話番号が代表電話となる。

required 
telephone string 

電話番号


required
maxLength : 100
pattern : [0-9\+\-*#PTpt()\u3000 ]+ 
type string 

電話番号タイプ

  • CELLPHONE: 携帯電話
  • WORK: 会社
  • HOME: 自宅
  • WORK_FAX: 会社 FAX
  • HOME_FAX: 自宅 FAX
  • OTHER: その他
  • CUSTOM: カスタム

default : CUSTOM
Allowed values : CELLPHONE, WORK, HOME, WORK_FAX, HOME_FAX, OTHER, CUSTOM 
customType string 

カスタム電話番号タイプ

  • 電話番号タイプが CUSTOM の場合に指定可能

maxLength : 100
nullable : true 

ContactOrganization

PropertyTypeDescription
primary boolean 

代表会社フラグ

  • リスト内で 1 つの会社/所属を代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初の会社/所属が代表会社/代表所属となる。

required 
name string 

会社名


maxLength : 100 
department string 

部署名


maxLength : 100 
title string 

役職名


maxLength : 100 

ContactEvent

PropertyTypeDescription
primary boolean 

代表イベントフラグ

  • リスト内で 1 つのイベントを代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初のイベントが代表イベントとなる。

required 
date string 

日付 (YYYY-MM-DD)


required
format : date 
type string 

イベントタイプ

  • BIRTHDAY: 誕生日
  • ANNIVERSARY: 記念日
  • OTHER: その他
  • CUSTOM: カスタム

default : CUSTOM
Allowed values : BIRTHDAY, ANNIVERSARY, OTHER, CUSTOM 
customType string 

カスタムイベントタイプ

  • イベントタイプが CUSTOM の場合に指定可能

maxLength : 100
nullable : true 
dayType string 

日付形式

  • SOLAR : 西暦
  • LUNAR : 旧暦

default : SOLAR
Allowed values : SOLAR, LUNAR 

ContactLocation

PropertyTypeDescription
primary boolean 

代表住所フラグ

  • リスト内で 1 つの住所を代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初の住所が代表住所となる。

required 
address string 

住所


required
maxLength : 100 
type string 

住所タイプ

  • WORK: 会社
  • HOME: 自宅
  • OTHER: その他
  • CUSTOM: カスタム

default : CUSTOM
Allowed values : WORK, HOME, OTHER, CUSTOM 
zipCode string 

郵便番号


maxLength : 100 
customType string 

カスタム住所タイプ

  • 住所タイプが CUSTOM の場合に指定可能

maxLength : 100
nullable : true 

ContactMessenger

PropertyTypeDescription
primary boolean 

代表 SNS フラグ

  • リスト内で 1 つの SNS を代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初の SNS が代表 SNS となる。

required 
id string 

SNS ID


required
maxLength : 100 
type string 

SNSタイプ

  • FACEBOOK: Facebook
  • LINE: LINE
  • X: X(Twitter)
  • CUSTOM: カスタム

default : CUSTOM
Allowed values : FACEBOOK, LINE, X, CUSTOM 
customType string 

カスタム SNS タイプ

  • SNS タイプが CUSTOM の場合に指定可能

maxLength : 100
nullable : true 

ContactWebsite

PropertyTypeDescription
primary boolean 

代表 Web サイトフラグ

  • リスト内で 1 つの Web サイトを代表 (primary=true) に指定する。
  • いずれも primary=true を指定しない場合は、最初の Web サイトが代表 Web サイトとなる。

required 
url string 

Web サイト URL


required
maxLength : 100
format : uri 

CxTalkInquiryChannel

PropertyTypeDescription
channelType string 

問い合わせ経路の種類

  • LINE_OA: LINE公式アカウント
  • WORKS: 外部の LINE WORKS アカウント
  • MAIL: メール

required
Allowed values : LINE_OA, WORKS, MAIL 
displayName string 

問い合わせ経路における顧客の名前

  • MAIL の場合には、メールアドレス

nullable : true 

CxTalkAccount

PropertyTypeDescription
name string 

窓口アカウント名


required 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "contacts": [3    {4      "contactId": "contact2-a56d-44a4-5304-033e16fca8d1",5      "contactName": {6        "lastName": "顧客",7        "firstName": "太郎",8        "nickName": "顧客太郎",9        "phoneticFirstName": null,10        "phoneticLastName": null,11        "prefix": null,12        "suffix": null,13        "middleName": null14      },15      "emails": [16        {17          "primary": true,18          "email": "example@example.com"19        }20      ],21      "telephones": [22        {23          "primary": true,24          "telephone": "090-0000-0001",25          "type": "CELLPHONE",26          "customType": null27        }28      ],29      "organizations": [30        {31          "primary": true,32          "name": "example company name",33          "department": "department",34          "title": "title"35        }36      ],37      "locations": [38        {39          "primary": true,40          "address": "example address",41          "type": "WORK",42          "zipCode": "100-0001",43          "customType": null44        }45      ],46      "events": [47        {48          "primary": true,49          "date": "2026-01-09",50          "type": "BIRTHDAY",51          "dayType": "SOLAR",52          "customType": null53        }54      ],55      "messengers": [56        {57          "primary": true,58          "id": "example1",59          "type": "LINE",60          "customType": null61        }62      ],63      "websites": [64        {65          "primary": true,66          "url": "https://example.com"67        }68      ],69      "memo": "memo",70      "contactTagIds": [71        "ctag2a81-94b6-4642-6903-03aa7977da91"72      ],73      "inquiryChannels": [74        {75          "channelType": "LINE_OA",76          "displayName": "顧客太郎"77        },78        {79          "channelType": "MAIL",80          "displayName": "example@example.com"81        }82      ],83      "cxtalkAccounts": [84        {85          "name": "商品問い合わせ窓口"86        }87      ],88      "createdTime": "2026-08-10T11:05:41+09:00",89      "modifiedTime": "2026-08-10T11:09:37+09:00"90    }91  ],92  "responseMetaData": {93    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="94  }95}

HTTP 400

Bad Request

HTTP 403

Forbidden