Skip to content
Bottle

List emails sent

GET
/email-log
curl --request GET \
  --url 'https://example.com/email-log?status=sent&limit=25&offset=0' \
  --cookie bottle.session_token=<bottle.session_token>

Newest first. q matches the address or the subject; status narrows to sent or failed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 200 characters
status
string
Allowed values: sent failed
limit
integer
default: 25 >= 1 <= 100
offset
integer | null
0

Responses

Section titled “Responses”

200

Section titled “200”

The emails

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
event
required
string
recipientKind
required
string
Allowed values: customer user address
to
required
string
subject
required
string
status
required
string
Allowed values: sent failed
error
required
string | null
attachments
required
Array<object>
object
filename
required
string
contentType
required
string
bytes
required
integer
createdAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "recipientKind": "customer",
      "status": "sent"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}