GET/users/{userId}/mail/mailfolders/favorite-contacts

Gets a list of favorite contacts folders.

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/mail/mailfolders/favorite-contacts

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • User ID
  • Login ID (email)
  • Me

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
favoriteContactsMailFolders array (object) 

Favorite contacts folder information


required
minItems : 0
uniqueItems : true 

object

PropertyTypeDescription
unreadMailCount integer 

Number of unread messages


required
format : int32 
mailCount integer 

Number of messages


required
format : int32 
folderName string 

Folder name


required
minLength : 1
maxLength : 250 
email string 

Email address


required
minLength : 1
format : email 

Response Example

example

1{2  "favoriteContactsMailFolders": [3    {4      "unreadMailCount": 6,5      "mailCount": 58,6      "folderName": "David",7      "email": "admin@example.com"8    },9    {10      "unreadMailCount": 15286,11      "mailCount": 15460,12      "folderName": "LINE WORKS",13      "email": "no_reply@worksmobile.com"14    },15    {16      "unreadMailCount": 0,17      "mailCount": 54,18      "folderName": "David_qtqt",19      "email": "qtqt@hbj.example.com"20    },21    {22      "unreadMailCount": 0,23      "mailCount": 1,24      "folderName": "David_fqfq",25      "email": "fqfq@example.com"26    }27  ]28}