Email Log

1 import { MercoaClient } from "@mercoa/javascript"; 2 3 const client = new MercoaClient({ token: "YOUR_TOKEN" }); 4 await client.organization.emailLog();

1 { 2 "count": 1, 3 "hasMore": true, 4 "data": [ 5 { 6 "id": "id", 7 "status": "PENDING", 8 "subject": "subject", 9 "from": "from", 10 "to": "to", 11 "htmlBody": "htmlBody", 12 "textBody": "textBody", 13 "createdAt": "2024-01-15T09:30:00Z", 14 "attachment": { 15 "filename": "filename", 16 "contentType": "contentType" 17 }, 18 "invoiceId": "invoiceId" 19 }, 20 { 21 "id": "id", 22 "status": "PENDING", 23 "subject": "subject", 24 "from": "from", 25 "to": "to", 26 "htmlBody": "htmlBody", 27 "textBody": "textBody", 28 "createdAt": "2024-01-15T09:30:00Z", 29 "attachment": { 30 "filename": "filename", 31 "contentType": "contentType" 32 }, 33 "invoiceId": "invoiceId" 34 } 35 ] 36 }

Get log of all emails sent to this organization. Content format subject to change.

Query parameters

startDatedatetimeOptional

endDatedatetimeOptional

fromstringOptional

Filter by sender email address

tostringOptional

Filter by recipient email address

limitintegerOptional

Number of logs to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstringOptional

The ID of the log to start after. If not provided, the first page of logs will be returned.

Response

This endpoint returns an object.

countinteger

Total number of logs for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMoreboolean

True if there are more logs available for the given filters.

datalist of objects

Headers

Query parameters

Response

Errors