Board

A board object contains information about a padlet.

If you want the data of each post and section to be included with the board object then make sure ?include=posts,sections is added to the end of the GET request URL. eg: GET https://api.padlet.dev/v1/boards/abcd1234ysdf57mg?include=posts,sections

An example of a board object is displayed below.

{
  "id": "abcd1234efgh5678",
  "type": "board",
  "attributes": {
    "title": "My wonderful padlet",
    "description": "Memories of the past",
    "builder": {
      "username": "j",
      "shortName": "Jerry",
      "fullName": "Jerry Seinfeld",
      "avatarUrl": "http://example.com"
    },
    "iconUrl": "https://padlet.net/icons/png/263a.png",
    "webUrl": {
      "live": "https://padlet.dev/api1/my-shiny-padlet-abcd1234efgh5678",
      "qrCode": "https://cdn.padlet.dev/padlets/abcd1234efgh5678/qr_code.png",
      "slideshow": "https://padlet.dev/api1/my-shiny-padlet-abcd1234efgh5678/slideshow",
      "slideshowQrCode": "https://cdn.padlet.dev/padlets/abcd1234efgh5678/slideshow_qr_code.png"
    },
    "domainName": "padlet.com",
    "settings": {
      "font": 1,
      "colorScheme": "light"
    },
    "createdAt": "2023-07-27T22:10:09.834Z",
    "updatedAt": "2023-07-27T22:10:09.834Z"
  },
  "relationships": {
    "sections": {
      "data": [
        {
          "type": "section",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "posts": {
      "data": [
        {
          "type": "post",
          "id": "abcd1234efgh5678"
        }
      ]
    }
  }
}

Board object properties

Properties	Type	Description
`id`	`string`	Board ID
`type`	`string`	Always `"board"`.
`attributes.title`	`string`	Title of the board
`attributes.description`	`string`	Description of the board
`attributes.builder`	`object`	User who created the board
`attributes.iconUrl`	`string`	Icon url of the board
`attributes.domainName`	`string`	Domain of board
`attributes.settings`	`object`	Settings of the board.
`attributes.createdAt`	`string`	Date and time when this board was created. Formatted as an ISO 8601 date time string.
`attributes.updatedAt`	`string`	Date and time when this board was updated. Formatted as an ISO 8601 date time string.
`relationships.sections`	`object`	List of section objects containing only `type` and `id` as per JSON:API specification.
`relationships.posts`	`object`	List of post objects containing only `type` and `id` as per JSON:API specification.