---
updatedAt: 2026-09-11T07:29:10.000Z
agentTools:
projectIndex: https://docs.padlet.dev/llms.txt
---
# Introduction
Welcome to the documentation of the Padlet API! We built this API to give our users even more ways to create beauty with Padlet.
# Getting Started
We will walk you through the process of getting started with the Padlet API, making an API request, and getting a response. We will use the `Retrieve board and post information` endpoint as an example.
## Prerequisites
You need a paid Padlet subscription to use the API. If unsure, visit the developer settings page and check if you can generate an API key.
## Step 1: Choose your padlet
In a browser, go to your dashboard and open the padlet you want to access using the API. **You must be an admin** of the padlet so pick one you have created.
On the right, click the more menu `...` and then the `Developer` button.
You'll see a panel with everything you need to immediately get started with the API.
## Step 2: Generate your API key
Click the `Generate` button in the pink box at the top.
This will generate your API key, which needs to be included in the `x-api-key` header of the requests you make.
## Step 3: Make the request!
Click the `Copy cURL` button for the `Retrieve board and post information` endpoint.
If you are on Mac, open a Terminal (or PowerShell if you are on Windows), paste the cURL into it and hit enter. You'll see a bunch of text pop up, which is the JSON response from our API. Copy it into a JSON formatter to view it easily.
Congratulations, you've made a successful request to the Padlet API!
Next, check out the details of the [post creation](https://padlet-api.readme.io/reference/add-post) endpoint to try that out as well.
***
# Supported Endpoints
## Basic Endpoints
| HTTP Method | Endpoints |
| :---------- | :------------------------------------------------------------------------------------------ |
| GET | [Board information](https://padlet-api.readme.io/reference/get-board-by-id) |
| POST | [Create post](https://padlet-api.readme.io/reference/add-post) |
| GET | [Get post attachment data](https://padlet-api.readme.io/reference/get-post-attachment-data) |
| GET | [Get current user's information](https://padlet-api.readme.io/reference/get-current-user) |
## Organization Endpoints
These endpoints require admin access to the organization.
| HTTP Method | Endpoints |
| :---------- | :------------------------------------------------------------------------------------------------- |
| GET | [Get organization by id](https://padlet-api.readme.io/reference/get-organization-by-id) |
| GET | [Get user's boards in organization](https://padlet-api.readme.io/reference/get-user-boards-in-org) |
# Conventions
The base URL to send all API requests is .
Our API follows the powerful JSON:API specification which means all API behavior is well-defined and predictable. Don't worry if you're not familiar with JSON:API, these docs are all you need.
* Top-level resource objects will have a `"type"` property indicating the type of resource (eg. `"board"`,`"post"`)
* Top-level resource objects may contain an `"attributes"` object. This object will contain relevant data about the resource object.
* Top-level resource objects may contain a `"relationships"` object describing relationships between the resource and other JSON:API resources.
* Property names are in `camelCase`.
* Padlet API does not support empty strings `""`. To unset a string value please use `null` instead.