Required permission: subscribers
GET
/api/v1/subscribers
Retrieves a list of subscribers.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
list_id |
string | Filter by list UUID |
status |
string | subscribed, unsubscribed, bounced |
limit |
integer | Number of results (default: 20, max: 100) |
offset |
integer | Pagination offset |
Response
{
"success": true,
"data": {
"subscribers": [
{
"id": "uuid-1234...",
"email": "user@example.com",
"name": "John Doe",
"status": "subscribed",
"metadata": {},
"created_at": "2026-01-01T00:00:00Z"
}
],
"total": 100,
"limit": 20,
"offset": 0
}
}
POST
/api/v1/subscribers
Adds a new subscriber.
Request Body
{
"email": "user@example.com",
"name": "John Doe", // optional
"list_id": "list-uuid-123",
"status": "subscribed", // optional: subscribed (default)
"metadata": { // optional
"company": "Acme Inc",
"plan": "pro"
}
}Response
{
"success": true,
"data": {
"id": "subscriber-uuid-123",
"email": "user@example.com",
"name": "John Doe",
"status": "subscribed",
"created_at": "2026-01-10T12:00:00Z"
}
}
GET
/api/v1/subscribers/{id}
Retrieves subscriber details.
Response
{
"success": true,
"data": {
"id": "subscriber-uuid-123",
"email": "user@example.com",
"name": "John Doe",
"status": "subscribed",
"metadata": {},
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-10T12:00:00Z"
}
}
PUT
/api/v1/subscribers/{id}
Updates subscriber information.
Request Body
{
"name": "Jane Doe",
"status": "subscribed",
"metadata": {
"company": "New Company"
}
}Response
{
"success": true,
"data": {
"id": "subscriber-uuid-123",
"email": "user@example.com",
"name": "Jane Doe",
"status": "subscribed",
"updated_at": "2026-01-10T12:00:00Z"
}
}
DELETE
/api/v1/subscribers/{id}
Deletes a subscriber.
Response
{
"success": true,
"message": "Subscriber deleted successfully"
}