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
401Bad or missing authentication token
402Plan limit exceeded (upgrade required)
404Resource not found (or belongs to another user)
422Validation error (check errors array)

Endpoints

Method Endpoint Description
GET/email_addressesList addresses
POST/email_addressesCreate address
PATCH/email_addresses/:idUpdate address
DELETE/email_addresses/:idDelete address
GET/email_addresses/:id/emailsList emails
DELETE/emails/:idDelete email
GET/foldersList folders
POST/foldersCreate folder
PATCH/folders/:idUpdate folder
DELETE/folders/:idDelete folder
GET/api_keysList keys
POST/api_keysCreate key
DELETE/api_keys/:idRevoke key
Previous
← For AI Agents