API Reference

Folders

Folders organize email addresses into groups. Each folder gets its own RSS feed that combines all emails from every address in the folder (including subfolders). Folders can be nested.

List folders

GET /api/v1/folders

Returns root folders with nested children and email addresses included.

Response 200


[
  {
    "id": 1,
    "name": "Newsletters",
    "rss_token": "Fm8pQr3x...",
    "parent_id": null,
    "children": [
      { "id": 2, "name": "Tech", "rss_token": "Yq2wNk9z..." }
    ],
    "email_addresses": [
      { "id": 1, "name": "General", "rss_token": "wKx9vBp7..." }
    ]
  }
]

Create a folder

POST /api/v1/folders

Parameter	Type	Description
name	string	Required. Folder name.
parent_id	integer	Optional. Parent folder ID for nesting.

Request


$ curl -X POST https://serssly.com/api/v1/folders \
    -H "Authorization: Token $SERSSLY_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"name": "Tech", "parent_id": 1}'

Update a folder

PATCH /api/v1/folders/:id

Update the name or move to a different parent.

Delete a folder

DELETE /api/v1/folders/:id

Deletes the folder. Email addresses in the folder are unassigned (not deleted). Returns 204 No Content.