Email History Endpoints
Query email delivery history and status.
Base Pathβ
/api/email-history
Endpointsβ
List Email Historyβ
GET /api/email-history
Authorization: Bearer {token}
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
page | number | Page number |
limit | number | Items per page |
email | string | Recipient email |
status | string | SENT, FAILED, QUEUED |
Response:
{
"items": [
{
"id": "uuid",
"name": "WELCOME_USER",
"email": "john@example.com",
"content": "Welcome to Gauzy...",
"status": "SENT",
"createdAt": "2025-01-15T10:00:00Z"
}
],
"total": 500
}
Get Email by IDβ
GET /api/email-history/:id
Authorization: Bearer {token}
Resend Emailβ
POST /api/email-history/:id/resend
Authorization: Bearer {token}
Delete Email Historyβ
DELETE /api/email-history/:id
Authorization: Bearer {token}
Email Typesβ
| Type | Description |
|---|---|
WELCOME_USER | New user welcome |
INVITE_EMPLOYEE | Employee invitation |
INVOICE_SENT | Invoice delivery |
PASSWORD_RESET | Password reset link |
TIMESHEET_SUBMITTED | Timesheet notification |
TASK_ASSIGNED | Task assignment |
Related Pagesβ
- Email Template Endpoints β templates
- Email Delivery Issues β troubleshooting
- Custom SMTP β SMTP configuration