Skip to content

API Reference

Authentication

All API endpoints require authentication via Bearer token.

bash
curl -H "Authorization: Bearer <token>" \
     https://api.zenlym.com/v1/emails

Endpoints

List Emails

http
GET /api/v1/emails

Query Parameters:

ParameterTypeDescription
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20)
categorystringFilter by category

Response:

json
{
  "data": [
    {
      "id": "uuid",
      "subject": "Meeting Tomorrow",
      "sender": "john@example.com",
      "category": "action_required",
      "received_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "total": 150
  }
}

Get Email Detail

http
GET /api/v1/emails/:id

Classify Email

http
POST /api/v1/emails/:id/classify

Rate Limiting

API is limited to 100 requests per minute per user.

Released under the MIT License.