Post

A post object contains information about a post. It contains relationships to a board, section, and attachmentData.

An example of a post object is displayed below.

{
  "id": "post_lkROZPOe62X2QjMg",
  "type": "post",
  "attributes": {
    "author": {
      "username": "Bobby",
      "shortName": "Bob",
      "fullName": "Bobby Fischer",
      "avatarUrl": "https://padlet.net/monsters/6451269.png"
    },
    "sortIndex": 364634009600,
    "content": {
      "subject": "Mitochondria",
      "bodyHtml": "The mitochondria is the powerhouse of the cell.",
      "attachment": {
        "url": "https://images.immediate.co.uk/production/volatile/sites/21/2019/03/bike_crash-1468595091943-1jedfc1vp3hut-1000-100-5a5ea67.jpg?quality=90&resize=768,574",
        "caption": "So close",
        "poll": null
      },
      "updatedAt": "2023-07-22T00:52:32Z"
    },
    "color": null,
    "status": "approved",
    "mapProps": {
      "longitude": null,
      "latitude": null,
      "locationName": null
    },
    "canvasProps": {
      "left": null,
      "top": null,
      "width": null
    },
    "webUrl": {
      "live": "https://padlet.dev/api1/my-shiny-padlet-abcd1234v9qj5snz/wish/1234"
    },
    "createdAt": "2023-07-22T00:52:32Z",
    "updatedAt": "2023-07-22T00:52:32Z",
    "customFields": [
      {
        "id": "Hg57JRb8",
        "key": "Priority",
        "value": "High"
      },
      {
        "id": "YLl9E2A8",
        "key": "Rating",
        "value": {
          "sum": 9,
          "count": 2,
          "userResponse": 5
        }
      }
    ]
  },
  "relationships": {
    "board": {
      "data": {
        "id": "3pbz27udysdf57mg",
        "type": "board"
      }
    },
    "section": {
      "data": {
        "id": "sec_xPdL4geL0PReqpwK",
        "type": "section"
      }
    },
    "attachmentData": {
      "links": {
        "related": "https://api.padlet.dev/v1/post/post_lkROZPOe62X2QjMg/attachmentData"
      }
    }
  }
}

Post object properties

Properties	Type	Description
`id`	`string`	Post ID
`type`	`string`	Always `post`
`attributes.author`	`object`	User who created the post.
`attributes.sortIndex`	`int`	Order of the post. Posts are sorted in increasing `sortIndex`.
`attributes.content`	`object`	Content object holding subject, body, and attachment information.
`attributes.color`	`string`	Color of the post.
`attributes.status`	`string`	Status of the post. Can be `"approved"`, `"pending_moderation"` or `"scheduled"`.
`attributes.mapProps`	`object`	Map properties of a post.
`attributes.canvasProps`	`object`	Canvas property of a post.
`attributes.createdAt`	`string`	Date and time when this post was created. Formatted as an ISO 8601 date time string.
`attributes.updatedAt`	`string`	Date and time when this post was updated. Formatted as an ISO 8601 date time string.
`attributes.customFields`	`array`	Array of custom field values for this post. Each object contains `id` (field ID, matching the keys of the board's `customFields`), `key` (field name) and `value`. For vote, rating and score fields, `value` is an object: `sum` and `count` of all responses, plus `userResponse` when the requesting user has responded.
`relationships.board`	`object`	Board object of which the post belongs to. Only contains `type` and `id` as per JSON:API specification.
`relationships.section`	`object`	Section object of which the post belongs to. Only contains `type` and `id` as per JSON:API specification.
`relationships.attachmentData`	`object`	Links object of the attachment data. Currently only supports url links and poll attachments.