Recent mail for a home screen
const url = 'https://mail.work.optidata.cloud/api/users/9e926fb1-e1ff-4fc9-81a1-5740f10ba57f/dashboard?limit=5';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://mail.work.optidata.cloud/api/users/9e926fb1-e1ff-4fc9-81a1-5740f10ba57f/dashboard?limit=5' \ --header 'Authorization: Bearer <token>'The most recent conversations in the user’s inbox, ready to be rendered as a home-screen widget. Only the authenticated user’s own dashboard may be read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”UUID of the user. Must be the authenticated user.
Query Parameters
Section titled “Query Parameters”How many conversations to return.
Responses
Section titled “ Responses ”The most recent conversations, newest first.
object
Id of the thread. A single-message thread reports the message id with the sign flipped.
Preview snippet of the newest message.
How an outgoing message came to be.
The state of a message or thread, as a set of booleans.
object
The user starred it.
It carries a calendar invitation.
A read receipt was requested.
The addresses of a message, grouped by role.
object
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
The messages of the thread. In a listing they carry ids and flags only; read the bodies with the reader operations.
A message as it appears inside a listing or a thread.
object
The RFC 5322 Message-ID header.
The state of a message or thread, as a set of booleans.
object
The user starred it.
It carries a calendar invitation.
A read receipt was requested.
The addresses of a message, grouped by role.
object
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
One participant of a message.
object
Display name, when one is known.
The role the address plays: f sender, t recipient, c carbon copy,
b blind copy, r reply-to.
Left empty in listings; read the body with a reader operation.
A file carried by a message.
object
MIME part number, used to download it.
The cid an inline image is referenced by inside the body.
attachment or inline.
Position used to name a file that arrived without one.
Icon hint for a file-type badge.
Signed download link, populated by the reader operations. Use it as-is.
A file carried by a message.
object
MIME part number, used to download it.
The cid an inline image is referenced by inside the body.
attachment or inline.
Position used to name a file that arrived without one.
Icon hint for a file-type badge.
Signed download link, populated by the reader operations. Use it as-is.
The calendar invitation carried by the message, when there is one.
The folder-sharing offer carried by the message, when there is one.
Deep link that opens this thread in the mail web client.
Examples
[ { "id": "-4186", "link": "https://mail.work.optidata.cloud/urn/acme/v1-10-eyJjb252ZXJzYXRpb25faWQiOi00MDAyfQ==", "date": "2026-08-19T12:45:28.000000Z", "subject": "Requested files", "fragment": "Hi Jane, here are the files you asked for…", "unreadMessages": 1, "totalMessages": 1, "type": "new", "replyServerMessageId": null, "tagIds": [], "flags": { "isUnread": true, "isFlagged": false, "hasAttachment": true, "isReplied": false, "isSentByMe": false, "isForwarded": false, "isInvite": false, "isDraft": false, "isDeleted": false, "isNotificationSent": false, "isUrgent": false, "isLowPriority": false, "isPriority": false }, "participants": { "from": [ { "name": "John Roe", "email": "john.roe@example.com", "type": "f" } ], "to": [ { "name": "Jane Doe", "email": "jane.doe@acme.example", "type": "t" } ], "cc": [], "bcc": [], "replyTo": [], "sender": [], "notification": [], "resentFrom": [] }, "messages": [] }]Missing, malformed or expired authentication key.
Authentication failures use an error key rather than message.
object
Examples
No bearer token sent
{ "error": "JWT passport exception: Missing bearer token in request"}The caller may not act on this mailbox, user or resource.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "This action is unauthorized."}The request body or query string failed validation.
object
The first validation message.
Validation messages keyed by field name.
object
Examples
{ "message": "The conversations field is required.", "errors": { "conversation_ids": [ "The conversations field is required." ] }}Rate limit exceeded. Retry after the window resets.
Generic error envelope used by policy, binding and framework failures.
object
Human-readable description of the failure.
Examples
{ "message": "Too Many Attempts."}