GET/contact-tags

Gets a list of contact tags. The tags are sorted by name.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

contact
contact.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/contact-tags

Query Parameters

ParameterTypeDescription
type string 

Tag type


Allowed values : COMPANY, USER
example : USER 
orderBy string 

Sort by: name. Sorting order: asc (default), desc. Use a blank space (%20) to separate "sort by" and "sort order."


example : name%20asc 
count integer 

Number of items returned at a time


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

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
contactTags array (ContactTag) 

Contact tag information

 
responseMetaData object (responseMetaData) 

Pagination information

 

ContactTag

PropertyTypeDescription
contactTagId string 

Contact tag ID


readOnly : true 
contactTagName string 

Tag name


required
maxLength : 30 
type string 

Tag type

  • COMPANY: Company tag
  • USER: User tag

Allowed values : COMPANY, USER
readOnly : true 
userId string 

User tag creator

  • It is displayed only if ContactTagType is USER.

readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

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