Welcome to the documentation of the Padlet API! We built this API to give our users even more ways to create beauty with 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
You'll see a panel with everything you need to immediately get started with the API.
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.
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 endpoint to try that out as well.
All of our endpoints include a
board_idin our path parameter. This
board_idrepresents the padlet we want to fetch and modify.
board_idis directly included in the url when on a padlet. Most times, it is the 16-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 the
The base URL to send all API requests is https://api.padlet.dev.
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.
- 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
- Padlet API does not support empty strings
"". To unset a string value please use