GET/users/{userId}/contact-tags

구성원이 접근 가능한 태그 목록을 조회한다.

Authorization

oauth2

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

Scope

contact
contact.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/contact-tags

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
type string 

태그 타입


Allowed values : COMPANY, USER
example : USER 
orderBy string 

정렬 대상: name. 정렬 순서: asc(기본값), desc. 정렬 대상과 순서는 공백으로 구분한다(separator: %20).


example : name%20asc 
count integer 

한 번에 가져오는 데이터 크기


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

커서


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
contactTags array (ContactTag) 

연락처 태그 정보

 
responseMetaData object (responseMetaData) 

페이지 매김 정보

 

ContactTag

PropertyTypeDescription
contactTagId string 

연락처 태그 ID


readOnly : true 
contactTagName string 

태그 이름


required
maxLength : 30 
type string 

태그 타입

  • COMPANY: 회사 태그
  • USER: 사용자 태그

Allowed values : COMPANY, USER
readOnly : true 
userId string 

사용자 태그 생성자

  • 사용자 태그인 경우에만 표시됨

readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 페이지 조회를 위한 커서

 

Response Example

example

1{2  "contactTags": [3    {4      "contactTagId": "ctag2a81-94b6-4642-6903-03aa7977da91",5      "contactTagName": "company tag",6      "type": "COMPANY"7    },8    {9      "contactTagId": "ctaguser-94b6-4642-6903-03aa7977da69",10      "contactTagName": "user tag",11      "type": "USER",12      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"13    }14  ],15  "responseMetaData": {16    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="17  }18}

HTTP 400

Bad Request

HTTP 403

Forbidden