GET/contacts/custom-properties

連絡先カスタムプロパティリストを取得する。

Authorization

oauth2

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

Scope

contact
contact.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/contacts/custom-properties

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
customProperties array (ContactCustomProperty) 

連絡先カスタムプロパティ情報

 

ContactCustomProperty

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
customPropertyId string 

カスタムプロパティ ID
登録時に自動発行されるユニーク ID


readOnly : true 
propertyName string 

連絡先カスタムプロパティ名
ドメイン内で一意
英数字とアンダーバー (_) のみ使用可能
英字またはアンダーバー (_) で始める


maxLength : 120 
displayName string 

連絡先カスタムプロパティの表示名
ドメイン内で一意


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

連絡先カスタムプロパティの表示名の多言語リスト


minItems : 0 
propertyType string 

連絡先カスタムプロパティタイプ

  • STRING: テキスト
  • LINK: リンク

Allowed values : STRING, LINK 
displayOrder integer 

表示順位 (重複許可)
値を指定しない (NULL) 場合、最後尾に指定される


minimum : 1
format : int32
nullable : true 
multiValued boolean 

複数値の許可
同一の連絡先カスタムプロパティに複数の値を登録できる


default : false 

I18nDisplayName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ja_JP, ko_KR, zh_CN, zh_TW, en_US 
name string 

表示名


maxLength : 20 

Response Example

example

1{2  "customProperties": [3    {4      "domainId": 10000001,5      "customPropertyId": "custompi-5ge3-f6d7-ht33-35gr6e465u01",6      "propertyName": "ext_id",7      "displayName": "外部 ID",8      "i18nDisplayNames": [9        {10          "language": "ja_JP",11          "name": "外部 ID"12        },13        {14          "language": "en_US",15          "name": "external id"16        }17      ],18      "propertyType": "STRING",19      "displayOrder": 1,20      "multiValued": false21    },22    {23      "domainId": 10000001,24      "customPropertyId": "custompi-5ge3-f6d7-ht33-35gr6e465u02",25      "propertyName": "connect_link",26      "displayName": "外部リンク",27      "propertyType": "LINK",28      "displayOrder": 2,29      "multiValued": false30    }31  ]32}

HTTP 404

Not Found