Introduction
What the Peleka API is, how requests and responses are shaped, and where to go next.
The Peleka API lets you manage contacts, tags, segments, custom fields, broadcasts, and forms programmatically, subscribe to workspace events with webhooks, and pull analytics: the same operations available in the dashboard, callable from your own backend.
It's a REST API, and requests and responses are both JSON. Authentication is a single API key sent as a header; see Authentication for how to get one.
Base URL
https://api.peleka.io/api/v1Response shape
Most responses wrap their payload in a data field:
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "[email protected]"
}
}List endpoints follow one of two pagination shapes, depending on the resource. See Pagination for which is which.
One exception worth knowing about: GET /webhooks/{id}/deliveries returns a paginated page inside the usual data wrapper, so you'll see data.data for the array of deliveries. It's not a typo — the outer data is the standard response envelope, the inner data is the paginated list itself.
Errors
Every error response follows RFC 7807 (Problem Details for HTTP APIs):
{
"type": "https://peleka.io/errors/404",
"title": "Contact not found",
"status": 404,
"detail": "Contact not found",
"instance": "/api/v1/contacts/550e8400-e29b-41d4-a716-446655440000"
}See Rate limits & errors for the status codes you'll actually run into.