GET/boards

Gets a list of boards based on the specified role.
This API operation does not get categories.
If the role parameter is set to WRITER, the operation requires read permission to get boards.

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

Query Parameters

ParameterTypeDescription
role string 

Board permissions
READER: Gets boards containing posts you are allowed to read.
WRITER - Gets boards containing posts you are allowed to write.


default : READER
Allowed values : READER, WRITER
example : WRITER 
count integer 

Number of items in a list


default : 100
minimum : 1
maximum : 200
example : 200
format : int32 
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
boards array (object) 
 
responseMetaData object (responseMetaData) 

Metadata for pagination

 

object

PropertyTypeDescription
boardId integer 

Board no.


required
format : int64 
boardName string 

Subject


required 
description string 

Description

 
createdTime string 

Creation time

  • Format: YYYY-MM-DDThh:mm:ssTZD

required
format : date-time
readOnly : true 
modifiedTime string 

Update time

  • Format: YYYY-MM-DDThh:mm:ssTZD

format : date-time
readOnly : true 
displayOrder integer 

Display order


required
format : int32
readOnly : true 
resourceLocation integer 

Resource location (location code)


format : int32 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "boards": [3    {4      "boardId": 100,5      "boardName": "Notice",6      "description": "Notice Description",7      "createdTime": "2019-08-24T14:15:22+09:00",8      "modifiedTime": "2022-10-28T17:26:35+09:00",9      "displayOrder": 1,10      "resourceLocation": 2410111    }12  ],13  "responseMetaData": {14    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="15  }16}