API Reference
Overview
The SeRSSly REST API uses JSON for request and response bodies. All endpoints require authentication unless noted otherwise.
Base URL
https://serssly.com/api/v1
Authentication
Include your API key as a Bearer token in every request:
Authorization: Token your-api-key-here
Pagination
List endpoints use keyset pagination. Responses include a pagination object with next_url and previous_url cursors. Follow next_url to fetch the next page.
{
"email_addresses": [...],
"pagination": {
"limit": 20,
"next_url": "/api/v1/email_addresses?cursor=eyJpZCI6MjB9",
"previous_url": null
}
}
Error responses
Errors return appropriate HTTP status codes with a JSON body:
| Status | Meaning |
|---|---|
| 401 | Bad or missing authentication token |
| 402 | Plan limit exceeded (upgrade required) |
| 404 | Resource not found (or belongs to another user) |
| 422 | Validation error (check errors array) |
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /email_addresses | List addresses |
| POST | /email_addresses | Create address |
| PATCH | /email_addresses/:id | Update address |
| DELETE | /email_addresses/:id | Delete address |
| GET | /email_addresses/:id/emails | List emails |
| DELETE | /emails/:id | Delete email |
| GET | /folders | List folders |
| POST | /folders | Create folder |
| PATCH | /folders/:id | Update folder |
| DELETE | /folders/:id | Delete folder |
| GET | /api_keys | List keys |
| POST | /api_keys | Create key |
| DELETE | /api_keys/:id | Revoke key |