GET/boards/posts/search

Search for posts on privileged boards.
search terms (query) are required.

  • Default search target: title, body, comment, attachment (file name and content)
  • Search terms are case-insensitive and URL encoding should be applied.
  • Search results are sorted in descending order of relevance.
  • The response uses the same model as the post list inquiry, and 'snippet' and 'boardName' are additionally provided only in the search response.
  • 'readCount' is always zero because it is not synchronized with the search index, and must-read information ('isMustRead'/'mustReadPeriod') is not provided in the search results.
  • 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

board
board.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/boards/posts/search

Query Parameters

ParameterTypeDescription
query string 

search term


required
minLength : 1
maxLength : 100
example : meeting minutes 
boardIds string 

Search target bulletin board ID (separated by commas, up to 50)
Search from all bulletin boards with read permission if not specified


example : 1,2,3 
hasAttachment boolean 

Whether to search only posts with attachments


default : false
example : false 
writerId string 

Author User ID


example : ba59054b-4345-46f7-19d6-03de1d47fe8f 
startTime string 

Search period start date (YYYY-MM-DD format)
If not specified, the entire period is searched, and there is no maximum search period limit.


example : 2026-01-01
format : date 
endTime string 

Search period end date (YYYY-MM-DD format)
If not specified, search by today.


example : 2026-04-28
format : date 
count integer 

Number of items in a list


default : 20
minimum : 1
maximum : 40
example : 40
format : int32 
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
posts array (undefined) 

List of post search results

 
responseMetaData object (responseMetaData) 

Metadata for pagination

 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "posts": [3    {4      "boardId": 100,5      "postId": 1,6      "title": "Meeting minutes",7      "readCount": 0,8      "commentCount": 2,9      "fileCount": 1,10      "createdTime": "2026-04-20T10:30:00+09:00",11      "modifiedTime": "2026-04-21T14:15:00+09:00",12      "isMustRead": false,13      "isUnread": true,14      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",15      "userName": "Susan Nielsen",16      "snippet": "This is <mark>Meeting minutes</mark>.",17      "boardName": "Notice"18    }19  ],20  "responseMetaData": {21    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="22  }23}