GET/users/{userId}/user-profile-statuses

Gets a list of member statuses. Each member can have one current status and one scheduled status.

Authorization

oauth2

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

Scope

user
user.read
directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/user-profile-statuses

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userProfileStatuses array (UserProfileStatusResponse) 
 

UserProfileStatusResponse

PropertyTypeDescription
userProfileStatusId string 

Member status ID

 
profileStatusId string 

Status ID.
BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01-CUSTOM12


Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
profileStatusName string 

Status name

 
iconUrl string 

Icon URL

 
scheduleType string 

Indicates whether the member status type is present or reserved.


Allowed values : PRESENT, RESERVED 
statusMessage string 

Status message


maxLength : 50
nullable : true 
startTime string 

Start date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
endTime string 

End date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

Auto reply settings


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

Auto replay settings for internal emails

 
external object (external) 

Auto replay settings for external emails

 

internal

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.

 

external

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.

 

Response Example

example

1{2  "statuses": [3    {4      "userProfileStatusId": "uprofile-b785-4aae-c330-01e94337846b",5      "profileStatusId": "BUSY",6      "profileStatusName": "Busy",7      "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-busy.png",8      "scheduleType": "PRESENT",9      "statusMessage": "status message1",10      "startTime": "2017-03-16T09:00:00+09:00",11      "endTime": "2017-03-18T18:00:00+09:00",12      "autoReplyMail": {13        "internal": {14          "content": "internal mail content",15          "sentDirectlyToMe": true16        },17        "external": {18          "content": "external mail content",19          "sentDirectlyToMe": false20        }21      }22    },23    {24      "profileStatusId": "ABSENCE",25      "userProfileStatusId": "f716ab8e-0766-4306-c794-01f2d902beaf",26      "profileStatusName": "Absent",27      "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-absence.png",28      "scheduleType": "RESERVED",29      "statusMessage": "status message2",30      "startTime": "2050-03-18T09:00:00+09:00",31      "endTime": "2050-03-20T18:00:00+09:00",32      "autoReplyMail": {33        "internal": {34          "content": "internal mail content",35          "sentDirectlyToMe": true36        },37        "external": {38          "content": "external mail content",39          "sentDirectlyToMe": false40        }41      }42    }43  ]44}