# paths./boards/{board_id}.parameters[].description
ID of board where you are admin. You can find how to get this on our [Introduction page](https://docs.padlet.dev/reference/introduction).

# paths./posts/{post_id}/attachmentData.get.description
Get post attachment information by post ID.

# paths./me.get.description
Get information about the currently authenticated user.

# paths./organizations/{org_id}.get.description
Get organization information. Requires admin access.

# paths./organizations/{org_id}.get.parameters[].description
Set to 'users' to include organization members in response

# paths./organizations/{org_id}/users/{user_id}.get.description
Get a user's boards within an organization. Requires admin access.

# paths./organizations/{org_id}/users/{user_id}.get.parameters[].description
Set to 'boards' to include user's boards in response

# paths./ai-recipe-boards.post.description
Creates a new AI-generated board using natural language instructions

# paths./posts/{post_hashid}/comments.parameters[].description
The unique identifier of the post to comment on

# paths./ai-recipe-boards/status/{status_key}.parameters[].description
Status key from AI recipe board creation

# paths./ai-recipe-boards/status/{status_key}.get.description
Gets the current status of an AI recipe board creation request

# components.schemas.board_attributes_read.properties.customFields.description
Custom field definitions configured for this board. Contains field IDs as keys and field configuration as values.

# components.schemas.board_settings.properties.font.description
Font ID for a board:
- 1 serif font
- 2 sans serif font
- 3 cursive font
- 4 monospaced font

# components.schemas.post_read.description
The contents of a padlet are written in posts

# components.schemas.comment_attributes_read.properties.attachment.description
Attachment properties object with a url field, or null if none

# components.schemas.post_write.description
The contents of a padlet are written in posts

# components.schemas.post_attributes_read.properties.customFields.description
Array of custom field values for this post. Each object contains key (field name) and value (field value).

# components.schemas.post_attributes_write.properties.customFields.description
Custom field values for this post. Keys should be the custom field IDs configured for the board, and values should be the field values.

# components.schemas.user_read_relationships.properties.relationships.title
has many boards and belongs to many organizations

# components.schemas.reaction_attributes_write.properties.value.description
The reaction value. Valid values depend on reaction type.

# components.schemas.reaction_attributes_write.properties.reactionType.description
The type of reaction. Defaults to board's configured type if not provided.

# components.schemas.ai_recipe_board_write.properties.attributes.properties.boardCreationInstructions.description
Natural language instructions for board creation

# components.schemas.ai_recipe_board_write.properties.attributes.properties.role.description
User role or context that AI should adopt i.e. kindergarten teacher

# components.schemas.ai_recipe_board_write.properties.attributes.properties.workspaceId.description
Workspace ID to create the board within a workspace

# components.schemas.ai_recipe_board_status_url.properties.attributes.properties.statusUrl.description
URL to poll for AI recipe board creation status

# components.schemas.comment_write.properties.data.properties.attributes.properties.attachment.properties.url.description
Public URL to the attachment (e.g. image, file)

# components.schemas.comment_write.properties.data.properties.attributes.properties.attachment.description
Attachment object. Currently only supports a single url field

# components.schemas.comment_write.x-examples.Example 1.data.attributes.htmlContent
Great point, thanks for sharing!

# components.schemas.ai_recipe_board_status.properties.attributes.properties.status.description
Current status of the AI recipe board creation

# components.schemas.ai_recipe_board_status.properties.attributes.properties.board.description
Optional. The created board object (only present when status is "success")

# components.parameters.board_id.description
ID of the board where you are admin. You can find how to get this on our Introduction page.

# components.parameters.include_posts_sections.description
comma-separated list of which related resources should be included

# components.parameters.include_boards.description
Set to 'boards' to include user's boards in response

# components.parameters.include_boards_organizations.description
comma-separated list of which related resources should be included

# components.responses.boardById.description
Returns resource object for the board with board_id

# components.responses.postsByBoardId.description
Returns resource objects for all posts in the board

# components.responses.newPost.description
Returns resource object for the post with assigned id, sort index, and populated author information

# components.responses.sectionsByBoardId.description
Returns resource objects for all sections in the board

# components.responses.newSection.description
Returns resource object for the post with assigned ID and sort index

# components.responses.newComment.description
Returns resource object for the created comment with assigned ID and populated author information

# components.responses.newComment.content.application/vnd.api+json.examples.Example 1.value.data.attributes.htmlContent
Great point, thanks for sharing!

# components.responses.attachmentData.content.application/vnd.api+json.schema.x-examples.URL Example.data.attributes.embedCode
The logo looks great pic.twitter.com/MhRYK3y78z
— Mark Zuckerberg (Parody) (@MarkZucker_) July 25, 2023

# components.responses.attachmentData.content.application/vnd.api+json.schema.properties.data.properties.attributes.properties.poll.description
Optional poll data when the attachment is a poll

# components.responses.attachmentData.content.application/vnd.api+json.schema.properties.data.properties.attributes.properties.poll.properties.closedAt.description
The date and time when the poll was closed. Null if still active.

# components.responses.organizationById.description
Returns resource object for the organization with org_id

# components.responses.userBoardsInOrg.description
Returns resource object for the user with their boards in the organization

# components.responses.aiRecipeBoardStatusNotFound.content.application/vnd.api+json.schema.properties.errors.items.properties.detail.example
No AI recipe board creation found with the provided status key

# components.responses.401-unauthorized.content.application/vnd.api+json.schema.properties.errors.items.properties.detail.example
Authentication required. Please provide a valid API key.

# components.responses.newReaction.description
Returns resource object for the reaction with assigned id and populated information

# components.responses.403-forbidden.content.application/vnd.api+json.schema.properties.errors.items.properties.detail.example
You must be an admin or owner of this organization.

# components.requestBodies.addPost.description
Resource object for the post to be created

# components.requestBodies.createAiRecipeBoard.description
Resource object for the AI recipe board to be created

# components.requestBodies.createReaction.description
Resource object for the reaction to be created

# components.requestBodies.addComment.content.application/vnd.api+json.examples.Example 1.value.data.attributes.htmlContent
Great point, thanks for sharing!

# components.requestBodies.addComment.description
Resource object for the comment to be created

# tags[].description
Operations related to comments on posts.

# tags[].description
Operations related to organizations and libraries.

# tags[].description
Operations for creating AI-generated boards using natural language instructions.

# tags[].description
Operations related to posts inside a board.

# tags[].description
Operations related to reactions on posts.