boards

View board

Changed on May 25, 2017

Returns a Board based on ID

get/v1/boards/{boardId}.json

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/restyaplatform/apis/restyaboard/docs/v1/boards/:boardId.json/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

boardIdinteger required

Selected board ID

Query parameters

tokenstring required

OAuth token

Response

successful operation

idinteger

createdstring

modifiedstring

user_idinteger

organization_idinteger

board_visibilityinteger

background_colorinteger

background_picture_urlstring

commenting_permissionsinteger

voting_permissionsinteger

inivitation_permissionsinteger

is_closedinteger

is_allow_organization_members_to_joininteger

boards_user_countinteger

list_countinteger

card_countinteger

boards_subscriber_countinteger

background_pattern_urlstring

boards_star_countinteger

is_show_image_front_of_cardinteger

background_picture_pathstring

music_namestring

music_contentstring

archived_list_countinteger

archived_card_countinteger

organization_namestring

organization_website_urlstring

organization_descriptionstring

organization_logo_urlstring

organization_visibilitystring

default_email_list_idinteger

is_default_email_position_as_bottominteger

custom_fieldsstring

Changes

May 25, 20175b98cb916342 Revision changes
- info
  api operation id getBoardById removed and replaced with
- info
  removed the non-success response with the status
- info
  removed the non-success response with the status
Apr 27, 20165d7a4c3eadce Revision changes
- info
  api operation id getBoardById was added
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history