Appearance
List outbound emails
GET
/api/emails/outbound
Return newest-first outbound emails for an organisation, including their recipients and current delivery states. Session-authenticated users must provide organisation_id; organisation API keys infer their organisation automatically. Results can be filtered by outbound email status or composition type.
Authorizations
ApiKey
Type
API Key (header: X-Api-Key)
Parameters
Query Parameters
organisation_id
Organisation whose outbound emails should be returned. Required for session-authenticated users.
Type
string
Format
"uuid"limit
The maximum number of outbound emails that can be returned in this request.
Type
number
Example
20Minimum
1Maximum
100Default
20offset
The number of matching outbound emails to skip.
Type
number
Example
0Minimum
0Default
0status
Filter outbound emails by their queue status.
Type
string
Valid values
"queued""sending""sent""failed"type
Filter outbound emails by how they were composed.
Type
string
Valid values
"new""reply""forward"Responses
application/json
JSON "total_count": 1, "options": { "limit": 20, "offset": 0, "status": "string", "type": "string" }, "data": [ { "recipients": [ { "id": "string", "type": "string", "email": "string", "name": "string", "delivery_status": "string", "last_event_type": "string", "last_event_at": "string", "accepted_at": "string", "queued_at": "string", "sent_at": "string", "delayed_at": "string", "deferred_at": "string", "delivered_at": "string", "bounced_at": "string", "expired_at": "string", "complained_at": "string", "unsubscribed_at": "string", "suppressed_at": "string", "rejected_at": "string", "failed_at": "string", "cancelled_at": "string", "last_smtp_code": "string", "last_enhanced_status_code": "string", "last_smtp_response": "string", "attempt_count": 0, "bounce_type": "string", "bounce_subtype": "string", "bounce_classification": "string", "complaint_feedback_type": "string" } ], "id": "string", "organisation_id": "string", "type": "string", "status": "string", "from": { "email": "support@mynamespace.mailisk.net", "name": "Support" }, "reply_to": { "email": "support@mynamespace.mailisk.net", "name": "Support" }, "subject": "string", "recipient_count": 0, "attachment_count": 0, "message_id": "string", "provider": "string", "provider_message_id": "string", "failure_reason": "string", "queued_at": "string", "sending_at": "string", "sent_at": "string", "failed_at": "string", "created_at": "string", "updated_at": "string" } ]
{
}