Get a mailbox action
Returns one action with its current progress. Send actions expose their immutable approved content, deadline, problem, and accepted receipt.
Returns one action with its current progress. Send actions expose their immutable approved content, deadline, problem, and accepted receipt. A caller with mailbox read access may inspect actions; send-only callers may inspect only their own proposals. Acceptance and mailbox completion do not mean recipient delivery.
Authorization
apiKey In: header
Path Parameters
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$^mbxact_[0-9a-hjkmnp-tv-z]{16,24}$Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/mailboxes/string/actions/string"{ "id": "string", "source": "humanUi", "proposedBy": { "kind": "user", "id": "string", "displayName": "string" }, "threadId": "string", "draftId": "string", "decision": { "outcome": "allow", "reason": "string", "policyId": "string", "source": "grant", "decidedAt": "string" }, "createdAt": "string", "updatedAt": "string", "type": "sendMessage", "state": "approvalRequired", "send": { "actionId": "string", "draftId": "string", "messageId": "string", "threadId": "string", "state": "approvalRequired", "acceptedAt": "string", "waitReason": "rate", "reviewExpectedAt": "string", "skippedRecipients": [ { "address": "string", "reason": "bounce", "unsubscribeGroupId": "string" } ], "executeUntil": "string", "retryAt": "string", "problem": { "code": "string", "message": "string", "error": { "_tag": "SenderNotReadyError", "message": "string", "sender": "string", "retryAfterSeconds": 0 } }, "retryEligible": true, "decision": { "outcome": "allow", "reason": "string", "policyId": "string", "source": "grant", "decidedAt": "string" }, "createdAt": "string", "updatedAt": "string" }, "intent": { "channel": "email", "draftRevision": 1, "from": "string", "fromName": "string", "to": [ "string" ], "cc": [ "string" ], "bcc": [ "string" ], "replyTo": [ "string" ], "subject": "string", "text": "string", "html": "string", "attachments": [ { "filename": "string", "content": "string", "mediaId": "string", "contentType": "string", "size": 1 } ], "threadId": "string", "conversationId": "string", "inReplyToMessageId": "string" }}Related documentation
Get a mailbox
Returns a mailbox with its endpoints and metadata; each endpoint says whether it is the mailbox's default on its channel.
Get mailbox activity
Counts the actions proposed and events recorded on a mailbox between `after` and `before` (omit both for all time), and the sends waiting for approval now.