GET
/
user
/
messages
curl --request GET \
  --url https://api.jsxmail.org/user/messages \
  --header 'Authorization: Bearer <token>'
{
  "messages": [
    {
      "id": "<string>",
      "to": [
        "<string>"
      ],
      "subject": "<string>",
      "senderId": "<string>",
      "status": "<string>",
      "userId": "<string>",
      "sentAt": "2023-11-07T05:31:56Z"
    }
  ],
  "take": 123,
  "page": 123,
  "skip": 123,
  "total": 123,
  "endDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "fromEmail": "jsmith@example.com",
  "toEmail": "jsmith@example.com",
  "statuses": "<string>",
  "bulkSending": "<string>",
  "hasNext": true,
  "totalPages": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
take
integer
default:10
required

Number of items to return per page (1-100)

Required range: 1 <= x <= 100
​
page
integer
default:1
required

Page number for pagination

Required range: x >= 1
​
includeStatusHistory
boolean
default:false

Include status history in the response

​
startDate
string

Filter messages from this date

​
endDate
string

Filter messages until this date

​
fromEmail
string

Filter messages by sender email

​
toEmail
string

Filter messages by recipient email

​
statuses
string

Filter messages by status (comma-separated list)

​
bulkSending
string

Filter messages by bulk sending ID

Response

200
application/json
List of messages with pagination information
​
messages
object[]
​
take
integer

Number of items per page

​
page
integer

Current page number

​
skip
integer

Number of items skipped

​
total
integer

Total number of messages

​
endDate
string

End date filter applied

​
startDate
string

Start date filter applied

​
fromEmail
string

Sender email filter applied

​
toEmail
string

Recipient email filter applied

​
statuses
string

Status filter applied

​
bulkSending
string

Bulk sending ID filter applied

​
hasNext
boolean

Whether there are more pages

​
totalPages
integer

Total number of pages