顧客/取引先の連絡先リストの照会

顧客/取引先の連絡先リストを照会します。

• 開始/終了日時フィルターで指定できる期間は最大 7 日間です。
• 開始/終了日時フィルターのどちらかのみ指定した場合、指定日から 7 日以内に作成/修正された連絡先情報を照会します。
• データは 最大 5 万件まで照会できます。
• page * maxResults 値が 5 万件以内になるようにフィルターを設定してください。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API ID}/contact/v3/domains/{domainId}/shared/contacts

HTTP Method

GET

Path Parameters

Request Parameter

Request Example

GET https://apis.worksmobile.com/r/apiid/contact/v3/domains/123/shared/contacts?page=1&maxResults=500&searchDateType=CREATION_TIME&startDateTime=2020-04-05T00%3A00%3A00%2B09%3A00&endDateTime=2020-04-06T00%3A00%3A00%2B09%3A00

Response

API の呼び出しに成功すると HTTP 200 コードと Response Body の「contacts」に顧客/取引先の連絡先情報をリストで返します。

Response Example

{
   "contacts":[
      {
         "resourceId":"230e2625-x31b-41d4-a916-689055440000",
         "open":true,
         "isCoEditing": true,
         "masterUserId": "account1@example.com",
         "name":{
            "firstName":"April",
            "lastName":"Jackson",
            "nickName":"Bella"
         },
         "emails":[
            {
               "address":"april.jackson@email.com",
               "represent":true
            }
         ],
         "creationTime":"2020-04-01T08:10:18+09:00",
         "modificationTime":"2020-04-03T07:30:04+09:00"
      },
      {
         "resourceId":"550e8400-e29b-41d4-a716-446655440000",
         "open":false,
         "isCoEditing": true,
         "masterUserId": "account1@example.com",
         "sharedMembers":[
            {
               "id":"account1@example.com",
               "type":"USER"
            },
            {
               "id":"account2@example.com",
               "type":"USER"
            },
            {
               "id":"account3@example.com",
               "type":"USER"
            },
            {
               "id":"orgunit1@example.com",
               "type":"ORGUNIT"
            }
         ],
         "tagResourceIds":[
            "efse4567-e89b-12d3-a456-426614174000",
            "774117c8-7a68-4c67-62a8-0312dd90b9b3"
         ],
         "name":{
            "firstName":"First Name",
            "lastName":"Last Name",
            "nickName":"Nickname"
         },
         "emails":[
            {
               "address":"example@email.com",
               "represent":true
            }
         ],
         "phones":[
            {
               "value":"0000-0001",
               "type":"WORK",
               "represent":true
            },
            {
               "value":"0000-0002",
               "type":"CUSTOM",
               "customType":"Custom Type",
               "represent":false
            }
         ],
         "organizations":[
            {
               "name":"Organization",
               "department":"Department",
               "title":"Job Title",
               "represent":true
            }
         ],
         "locations":[
            {
               "value":"Home Address",
               "zipcode":"000-111",
               "type":"HOME",
               "represent":true
            },
            {
               "value":"Custom Address",
               "zipcode":"000-111",
               "type":"CUSTOM",
               "customType":"Custom type",
               "represent":false
            }
         ],
         "events":[
            {
               "value":"20170313",
               "dayType":"S",
               "type":"BIRTHDAY",
               "represent":true
            }
         ],
         "messengers":[
            {
               "id":"lineid",
               "type":"LINE",
               "represent":true
            },
            {
               "id":"customid",
               "type":"CUSTOM",
               "customType":"customlabel",
               "represent":false
            }
         ],
         "websites":[
            {
               "value":"homepage.com",
               "represent":true
            }
         ],
         "photos":[
            {
               "path":"/upload/photo/1234.jpg",
               "represent":true
            }
         ],
         "memo":"Memo content",
         "worksAt":[
            {
               "type":"LINE",
               "resourceId":"741ec794-9bf8-4759-1eef-03ffa18ca759",
               "buddyUserIds":[
                  "account1@example.com"
               ]
            }
         ],
         "creationTime":"2020-04-05T19:30:04+09:00",
         "modificationTime":"2020-04-06T21:30:04+09:00"
      }
   ],
   "nextPage":2
}

Error Code

API の呼び出しに失敗するとエラーコードとエラーメッセージを返します。
詳細はエラーコードはアドレス帳APIのエラーコードを参照してください。