Board

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. It is the 16-character or 20-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": {
      "Hg57JRb8": "Priority",
      "YLl9E2A8": "Rating"
    },
    "customFieldDefinitions": [
      {
        "id": "Hg57JRb8",
        "name": "Priority",
        "type": "single_select",
        "sortIndex": 0,
        "required": true,
        "options": [
          { "id": "a1B2c3D4", "name": "High", "sortIndex": 0 },
          { "id": "e5F6g7H8", "name": "Low", "sortIndex": 1 }
        ]
      },
      {
        "id": "YLl9E2A8",
        "name": "Rating",
        "type": "rating",
        "sortIndex": 1,
        "required": false,
        "max": 5
      }
    ]
  },
  "relationships": {
    "sections": {
      "data": [
        {
          "type": "section",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "posts": {
      "data": [
        {
          "type": "post",
          "id": "abcd1234efgh5678"
        }
      ]
    },
    "comments": {
      "data": [
        {
          "type": "comment",
          "id": "abcd1234efgh56789"
        }
      ]
    }
  }
}

Board object properties

PropertiesTypeDescription
idstringBoard ID
typestringAlways "board".
attributes.titlestringTitle of the board
attributes.descriptionstringDescription of the board
attributes.builderobjectUser who created the board
attributes.iconUrlstringIcon url of the board
attributes.domainNamestringDomain of board
attributes.settingsobjectSettings of the board.
attributes.createdAtstringDate and time when this board was created. Formatted as an ISO 8601 date time string.
attributes.updatedAtstringDate and time when this board was updated. Formatted as an ISO 8601 date time string.
attributes.customFieldsobjectMap of custom field ID to field name for this board. Use customFieldDefinitions for each field's type and settings.
attributes.customFieldDefinitionsarrayDefinitions of the board's custom fields, sorted by sortIndex. See Custom field definitions.
relationships.sectionsobjectList of section objects containing only type and id as per JSON:API specification.
relationships.postsobjectList of post objects containing only type and id as per JSON:API specification.
relationships.commentsobjectList of comment objects containing only type and id as per JSON:API specification.

Custom field definitions

attributes.customFieldDefinitions describes each custom field on the board. It is returned by GET /boards/{board_id} and PATCH /boards/{board_id}.

Each definition's id is the same id that appears on that field's entries in a post's attributes.customFields, and the same key used in the board's attributes.customFields map. Use it to match a post's values to the field's definition.

Every definition has these properties:

PropertiesTypeDescription
idstringCustom field ID.
namestringCustom field name.
typestringOne of text, number, date, url, email, phone_number, link_button, user, single_select, vote, rating or score.
sortIndexnumberOrder of the field. Fields are sorted in increasing sortIndex.
requiredbooleanWhether a value is required on posts.

Some types have extra properties:

TypePropertyTypeDescription
single_selectoptionsarrayThe choices of the field. Each option has id, name and sortIndex. Options are sorted by increasing sortIndex.
votevoteTypestringupvotes_only allows a vote of 1. upvotes_and_downvotes allows a vote of 1 or -1.
ratingmaxintegerThe highest rating. A rating is a whole number from 1 to max.
scoremaxintegerThe highest score. A score is a whole number from 0 to max.

The other types (text, number, date, url, email, phone_number, link_button and user) have only the common properties.

Multi-select fields are not yet supported in customFieldDefinitions; they remain in the existing customFields map.

A board with no supported custom fields returns an empty array. The attribute is omitted when the board is returned as a related record without its definitions loaded.