ConnectCloud Developers

What desk made of received mail: created, appended, held, dropped, unrouted, failed (desk:admin)

GET /api/desk/v1/mail-log

Module: Desk · operationId: listMailLog · Tag: Mail · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
disposition query string Comma-separated dispositions, e.g. held_spam,held_rate
limit query integer (max 200)
offset query integer

Responses

  • 200 Page (application/json)

Fields of the 200 answer:

  • items (array of MailLogEntry)
    • ai (object): Decisions of the AI: classify (unclear mail) and route (space of a new ticket)
      • classify (MailAIUse)
        • choice (string): What the AI chose
        • confidence (number): Confidence of the AI (0–1)
        • logId (string): AI call log record
        • used (boolean): The AI was asked
      • route (MailAIUse)
        • choice (string): What the AI chose
        • confidence (number): Confidence of the AI (0–1)
        • logId (string): AI call log record
        • used (boolean): The AI was asked
    • classification (string): What desk classified the mail as
    • commsMailId (string): Received mail in comms
    • createdAt (string (date-time)): When desk processed the mail
    • disposition (string): What desk made of the mail (one of created, appended, duplicate, bounce_processed, auto_dropped, bulk_dropped, loop_dropped, held_spam, held_rate, unrouted, failed, released)
    • emlDocumentId (string): DMS document of the original mail (.eml): set for received mails, and for sent mails once comms archived them (after the sent event); the file is a ticket file of source eml
    • entryId (string): Entry the mail became
    • from (string): Sender address
    • id (string): Id of the log record
    • itemId (string): Ticket created or appended to
    • itemNumber (integer): Number of that ticket
    • mailboxId (string): comms mailbox the mail came in through
    • reason (string): Why the mail was held, dropped or failed
    • receivedAt (string (date-time)): When the mail was received
    • subject (string): Subject
  • total (integer)

Example 200 answer:

{
  "items": [
    {
      "classification": "reply",
      "commsMailId": "2a9b0c1d-3e4f-4a5b-8c7d-9e0f1a2b3c02",
      "createdAt": "2026-11-17T15:02:03Z",
      "disposition": "appended",
      "entryId": "1b8c9d0e-2f3a-4b4c-9d6e-8f9a0b1c2d07",
      "from": "katrin.stadler@alpenhotel-seeblick.example",
      "id": "1f8a9b0c-2d3e-4f4a-9b6c-8d9e0f1a2b02",
      "itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5c01",
      "itemNumber": 1,
      "mailboxId": "3f0a1b2c-4d5e-4f6a-9b8c-0d1e2f3a4b01",
      "receivedAt": "2026-11-17T15:02:00Z",
      "subject": "AW: [#1] WLAN in den Gästezimmern 2. OG fällt immer wieder aus"
    },
    {
      "classification": "spam",
      "commsMailId": "2a9b0c1d-3e4f-4a5b-8c7d-9e0f1a2b3c01",
      "createdAt": "2026-11-18T06:02:13Z",
      "disposition": "held_spam",
      "from": "angebote@gewinnspiel.example",
      "id": "1f8a9b0c-2d3e-4f4a-9b6c-8d9e0f1a2b01",
      "mailboxId": "3f0a1b2c-4d5e-4f6a-9b8c-0d1e2f3a4b01",
      "reason": "Absender ist neu, Text enthält nur einen Link",
      "receivedAt": "2026-11-18T06:02:11Z",
      "subject": "Ihr Gewinn wartet"
    }
  ],
  "total": 2
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/mail-log' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI