Skip to content
MailDock Docs

/messages (GET)

GET
/messages
curl --request GET \
  --url 'https://example.com/api/v1/messages?status=queued&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Messages sent through this resource, newest first.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: queued sent deferred bounced rejected failed unknown
tag
string
>= 1 characters <= 64 characters
limit
integer
default: 50 >= 1 <= 100
offset
integer
0 <= 9007199254740991

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
messageId
required
string
status
required
string
Allowed values: queued sent deferred bounced rejected failed unknown
from
required
object
email
required
string
name
string
<= 200 characters
to
required
Array<object>
object
email
required
string
name
string
<= 200 characters
cc
required
Array<object>
object
email
required
string
name
string
<= 200 characters
bcc
required
Array<object>
object
email
required
string
name
string
<= 200 characters
subject
required
string
sizeBytes
required
integer
>= -9007199254740991 <= 9007199254740991
tags
required
Array<string>
metadata
required
object
key
additional properties
string
error
required
Any of:
string
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
total
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "items": [
    {
      "status": "queued"
    }
  ]
}