Introduction
The Palmframe REST API lets you manage posts, subscribers, and your publication programmatically.
The Palmframe API is a REST API for building on top of your newsletter. Use it to draft and publish posts, manage your audience of subscribers, and read or update your publication settings — everything the dashboard does, available programmatically.
Base URL
All API requests are made to:
https://palmframe.com/api/v1Every endpoint documented here is relative to this base URL. For example, the
posts collection lives at https://palmframe.com/api/v1/posts.
Conventions
The API follows predictable REST conventions:
- Resources are addressed by their
id. - Request and response bodies are JSON. Send
Content-Type: application/jsonon requests with a body. POSTcreates resources,GETreads them,PATCHapplies partial updates, andDELETEremoves them.- All timestamps are ISO 8601 strings in UTC (for example
2026-07-14T09:30:00.000Z).
Response envelope
A single resource is returned as a JSON object with an object field that
identifies its type:
{
"object": "post",
"id": "post_abc123",
"title": "Hello, world"
}Collections are returned as a list envelope with an
object of "list":
{
"object": "list",
"data": [{ "object": "post", "id": "post_abc123" }],
"pagination": {
"limit": 25,
"has_more": false,
"next_cursor": null
}
}Errors are returned as an error envelope:
{
"error": {
"code": "not_found",
"message": "No post was found with that id."
}
}OpenAPI
A machine-readable OpenAPI 3.1 description of the API is available at:
https://palmframe.com/api/v1/openapi.jsonUse it to generate clients, explore the API in tools like Postman or Insomnia, or feed it into your own tooling.
Next steps
- Authentication — create an API key and make your first request.
- Pagination — page through large collections.
- Errors — handle failures gracefully.