v4

latestSwagger 2.02026-08-0343714211.7 MB
email_logs
Email Logs

List Email Logs

List Email Logs

get/email_logs

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 1000, 1,000 or less is recommended).

If set, return records where the specified field is equal to the supplied value. Valid fields are status and created_at. Valid field combinations are [ status ], [ created_at ] or [ status, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at. Valid field combinations are [ status ], [ created_at ] or [ status, created_at ].

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ status ], [ created_at ] or [ status, created_at ].

If set, return records where the specified field is less than the supplied value. Valid fields are created_at. Valid field combinations are [ status ], [ created_at ] or [ status, created_at ].

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ status ], [ created_at ] or [ status, created_at ].

Response

A list of EmailLogs objects.

timestampstring date-time

Start Time of Action. Deprecrated: Use created_at.

messagestring

Log Message

status'success' | 'failure' | 'suppressed'

Status of E-Mail delivery

subjectstring

Subject line of E-Mail

tostring

To field of E-Mail

ccstring

CC field of E-Mail

delivery_methodstring

How was the email delivered? customer_smtp or files.com

smtp_hostnamestring

Customer SMTP Hostname used.

smtp_ipstring

Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).

created_atstring date-time

Start Time of Action

Example response

[
  {
    "timestamp": "2000-01-01T01:00:00Z",
    "message": "example",
    "status": "success",
    "subject": "example",
    "to": "example",
    "cc": "example",
    "delivery_method": "example",
    "smtp_hostname": "example",
    "smtp_ip": "example",
    "created_at": "2000-01-01T01:00:00Z"
  }
]