GET/boards/{boardId}/posts/{postId}/readers

Gets the members who have read a post.
This API operation cannot get a post from Trash.

Authorization

oauth2

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

Scope

board
board.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/boards/{boardId}/posts/{postId}/readers

Path Parameters

ParameterTypeDescription
boardId integer 

Board ID


required
example : 100
format : int64 
postId integer 

Post ID


required
example : 1
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
readers array (object) 

maxItems : 5000 
responseMetaData object (responseMetaData) 

Metadata for pagination

 

object

PropertyTypeDescription
userId string 

Author ID.
It is empty if the author's account is deleted.


example : user7149-0ccd-433d-1eba-04f6901660dc
readOnly : true
nullable : true 
userName string 

Author name


required
example : Susan Nielsen
readOnly : true 
isRead boolean 

Indicates whether the post is read.


required
example : false
readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "readers": [3    {4      "userId": "user7149-0ccd-433d-1eba-04f6901660dc",5      "userName": "Susan Nielsen",6      "isRead": true7    }8  ],9  "responseMetaData": {10    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="11  }12}