GET/groups/{groupId}/note/posts/search

Search for posts in privileged team/group notes.
Search term (query) is required.

  • Default search targets: subject, body, comment, attachment name, author name
  • Search terms are case-insensitive and URL encoding should be applied.
  • Search results are sorted in descending order of relevance.
  • Duration/author/attachment filters are not supported and always search for the entire period.
  • The response uses the same model as the note post list inquiry, and an additional 'snippet' is provided only in the search response.
  • 'readCount'/'likeCount' is always 0 because it is not synchronized with the search index, and 'enableCollaboration' is always true.
  • Post registration/modification may be delayed several seconds until the search index is reflected.
  • rate limit follows the Open API common rate limit policy.

Authorization

oauth2

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

Scope

group.note
group.note.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/{groupId}/note/posts/search

Path Parameters

ParameterTypeDescription
groupId string 

Team/group ID


required
example : group127-8545-4463-603b-04d550d23bf 

Query Parameters

ParameterTypeDescription
query string 

search term


required
minLength : 1
maxLength : 100
example : meeting minutes 
count integer 

Number of items in a list


default : 20
minimum : 1
maximum : 40 
cursor string 

Cursor value for pagination


example : sfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
posts array (posts) 

Search Result

 
responseMetaData object (responseMetaData) 

Metadata for pagination

 

posts

PropertyTypeDescription
postId integer 

Post no.


format : int64 
title string 

Subject


required
minLength : 1
maxLength : 200 
enableCollaboration boolean 

Indicates whether to allow co-editing.

 
readCount integer 

Number of reads
Post search responses are always zero because they are not synchronized to the search index.


format : int64 
commentCount integer 

Number of comments


format : int64 
fileCount integer 

Number of files


format : int64 
likeCount integer 

Number of likes
Post search responses are always zero because they are not synchronized with the search index.


format : int64 
createdTime string 

Creation time


required
format : date-time
readOnly : true 
modifiedTime string 

Update time


format : date-time
readOnly : true 
userId string 

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


readOnly : true
nullable : true 
userName string 

Author name


required
readOnly : true 
isNotice boolean 

Indicates whether it is a notice.

 
snippet string 

Excerpts of parts where the search word matches (up to 200 characters)
The matched search word is highlighted by the '' element, and no other HTML tags are included.

 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "posts": [3    {4      "postId": 1,5      "title": "Meeting Minutes",6      "enableCollaboration": true,7      "readCount": 0,8      "commentCount": 2,9      "fileCount": 1,10      "likeCount": 0,11      "createdTime": "2026-04-20T10:30:00+09:00",12      "modifiedTime": "2026-04-21T14:15:00+09:00",13      "userId": "user7149-0ccd-433d-1eba-04f6901660dc",14      "userName": "Susan Nielsen",15      "isNotice": false,16      "snippet": "This is meeting<mark>minutes</mark>."17    }18  ],19  "responseMetaData": {20    "nextCursor": "sfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="21  }22}