A board object contains information about a padlet.

📘
Finding board_id
Some of our endpoints include a board_id in our path parameter. This board_id represents the padlet we want to fetch and modify.
The board_id is directly included in the url when on a padlet. Most times, it is the 16-character string at the end of the url.
You can also find board_id while viewing a padlet by clicking the more menu ... on the right side of the screen and then the Developer button.

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

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",
    "customFields": {}
  },
  "relationships": {
    "sections": {
      "data": [
        {
          "type": "section",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "posts": {
      "data": [
        {
          "type": "post",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "comments": {
      "data": [
        {
          "type": "comment",
          "id": "abcd1234efgh56789"
        }
      ]
    }
  }
}

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.
`attributes.customFields`	`object`	Custom field definitions configured for this board. Contains field IDs as keys and field configuration as values.
`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.
`relationships.comments`	`object`	List of comment objects containing only `type` and `id` as per JSON:API specification.