GET/contact-tags

連絡先タグリストを取得する。

  • タグリストはタグ名でソートする。

Authorization

oauth2

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

Scope

contact
contact.read

HTTP Request

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

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 

リストのカーソル値 (URL エンコードする)


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 

マイタグの作成者

  • タグタイプが USER の場合のみ表示される。

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