GET/contacts/custom-properties

도메인의 연락처 커스텀 속성을 모두 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

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. 자동으로 부여되는 값


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 : ko_KR, ja_JP, 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": "ko_KR",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