A board object contains information about a padlet.
Findingboard_idSome of our endpoints include a
board_idin our path parameter. Thisboard_idrepresents the padlet we want to fetch and modify.The
board_idis 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_idwhile viewing a padlet by clicking the more menu...on the right side of the screen and then theDeveloperbutton.
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
| 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 | Map of custom field ID to field name for this board. Use customFieldDefinitions for each field's type and settings. |
attributes.customFieldDefinitions | array | Definitions of the board's custom fields, sorted by sortIndex. See Custom field definitions. |
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. |
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:
| Properties | Type | Description |
|---|---|---|
id | string | Custom field ID. |
name | string | Custom field name. |
type | string | One of text, number, date, url, email, phone_number, link_button, user, single_select, vote, rating or score. |
sortIndex | number | Order of the field. Fields are sorted in increasing sortIndex. |
required | boolean | Whether a value is required on posts. |
Some types have extra properties:
| Type | Property | Type | Description |
|---|---|---|---|
single_select | options | array | The choices of the field. Each option has id, name and sortIndex. Options are sorted by increasing sortIndex. |
vote | voteType | string | upvotes_only allows a vote of 1. upvotes_and_downvotes allows a vote of 1 or -1. |
rating | max | integer | The highest rating. A rating is a whole number from 1 to max. |
score | max | integer | The 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.
