Comments and internal notes (desk:read)
GET /api/desk/v1/items/{ref}/entries
Module: Desk · operationId: listItemEntries · Tag: Activity · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit |
query | integer | Rows per page (default 200) (default 200; max 500) |
|
cursor |
query | string | The nextCursor of the previous page (keyset, bound to the list and its order); anything else is 400 invalid with field: cursor. |
|
ref |
path | string | yes | Item id or number |
Responses
- 200 Entries (
application/json)
Fields of the 200 answer:
items(array of Entry, required)aiGenerated(boolean): The text was written with AI helpauthorKind(string): external: a third party who answered an internal mail (the entry is internal) (one ofagent,requester,system,ai,rule,external)authorName(string): Name of the authorauthorRef(string): Login (e-mail) of the authorautomated(boolean): Written by a rule or service; never counts as a first responsebody(string): Markdownchannel(string): Where the entry came from (one ofui,mail,portal,api)createdAt(string (date-time)): When the entry was writteneditedAt(string (date-time)): When the entry was last editedid(string): Id of the entryitemId(string): Item the entry belongs tokind(string): comment, email_in, email_out or systemmail(object): Mail of email_in and email_out entries: direction, from, to, cc, subject, deliveryState (draft, queued, sent, delivered, deferred, bounced, failed, suppressed), recipientStates, attachmentsinReplyToEntryId(string): Outgoing mails: the mail entry of the ticket it answers; a draft keeps it when it is saved or sent without inReplyToEntryIdincludeChain(boolean): Sent mails: whether the earlier mails of the ticket went out below the textmainText(string): Received mails: the text without quoted history, signature, closing and legal footer; missing when nothing was cut or the entry was edited.bodystays the full text.thirdParty(boolean): An internal mail to or from third parties (suppliers, …; sent with visibility internal or answering one). An internal mail without it – a customer mail a merge or move hid – still belongs to the customer's thread.trimMethod(string): How mainText was found: rules on the text, or the AI for a long mail (settings.mail.aiTrim) (one ofheuristic,ai)
mailNote(string): why no mail was sent for a public comment (work_type: the ticket type has the work focus, comments on it are never mailed) (one ofno_mailbox,no_recipient,mail_unavailable,work_type)movedFromId(string): Item the entry was moved fromvisibility(string): internal: only staff see it; public: the requester sees it too (one ofinternal,public)
nextCursor(string): Cursor of the next page (pass it ascursor); missing on the last page.
Example 200 answer:
{
"items": [
{
"aiGenerated": false,
"authorKind": "agent",
"authorName": "Sophie Huber",
"authorRef": "sophie.huber@muster-it.example",
"automated": false,
"body": "Guten Morgen Frau Stadler, danke für die Meldung. Wir prüfen die Access Points im 2. OG per Fernzugriff und melden uns bis 10 Uhr.",
"channel": "ui",
"createdAt": "2026-11-17T07:20:00Z",
"id": "1b8c9d0e-2f3a-4b4c-9d6e-8f9a0b1c2d02",
"itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5c01",
"kind": "email_out",
"visibility": "public"
},
{
"aiGenerated": false,
"authorKind": "agent",
"authorName": "Lukas Wimmer",
"authorRef": "lukas.wimmer@muster-it.example",
"automated": false,
"body": "Controller zeigt AP-207 mit ständigen Neustarts (PoE-Budget am Switch im Technikraum 2. OG überschritten).",
"channel": "ui",
"createdAt": "2026-11-17T08:40:00Z",
"id": "1b8c9d0e-2f3a-4b4c-9d6e-8f9a0b1c2d03",
"itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5c01",
"kind": "comment",
"visibility": "internal"
}
],
"nextCursor": "eyJpZCI6IjFiOGM5ZDBlIn0"
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/desk/v1/items/string/entries' \
-H "Authorization: Bearer $ACCESS_TOKEN"