List Messages

GET

/api/creative/email/messages/

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

List messages for an account + folder with pagination, sorting, and filtering.

Parameters

Query Parameters

account_id

required

Account Id

string

folder

Folder

string

default: inbox

offset

Offset

integer

0

limit

Limit

integer

default: 50

sort_by

Sort By

string

default: date

sort_order

Sort Order

string

default: desc

filter_unread

Filter Unread

boolean

filter_starred

Filter Starred

boolean

Responses

200

Successful Response

EmailMessageListResponse

Response wrapper for message list operations.

object

success

required

Success

Operation success

boolean

messages

Messages

Array<object>

EmailMessageData

A single email message.

object

id

required

Id

Message ID

string

accountId

required

Accountid

string

messageId

required

Messageid

string

folder

required

Folder

string

subject

required

Subject

string

fromAddress

required

Fromaddress

string

fromName

required

Fromname

string

toAddresses

Toaddresses

Array<object>

EmailAddressData

Reusable email address with optional display name.

object

name

Name

string

""

address

required

Address

string

ccAddresses

Ccaddresses

Array<object>

EmailAddressData

Reusable email address with optional display name.

object

name

Name

string

""

address

required

Address

string

bccAddresses

Bccaddresses

Array<object>

EmailAddressData

Reusable email address with optional display name.

object

name

Name

string

""

address

required

Address

string

bodyText

required

Bodytext

string

bodyHtml

required

Bodyhtml

string

isRead

required

Isread

boolean

isStarred

required

Isstarred

boolean

isDeleted

required

Isdeleted

boolean

isSpam

required

Isspam

boolean

spamScore

required

Spamscore

number

hasAttachments

required

Hasattachments

boolean

attachmentsMeta

Attachmentsmeta

Array<object>

AttachmentMetaData

Metadata for an email attachment.

object

name

required

Name

string

size

required

Size

integer

contentType

required

Contenttype

string

storedPath

Storedpath

string

""

inReplyTo

Any of:

string

string

null

null

referencesHeader

required

Referencesheader

string

threadId

Threadid

string

""

dateSent

required

Datesent

integer

createdAt

required

Createdat

Unix timestamp

integer

modifiedAt

required

Modifiedat

Unix timestamp

integer

total

Total

integer

0

error

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object