Beam Help
Get help now

How-to · Zoho DESK

How to get event comment details in Zoho Desk

Retrieve detailed information about a specific event comment.

Retrieving the details of a specific comment on a Zoho Desk event is a single authenticated GET request that returns the full comment record when you supply both the event and comment identifiers.


Why this matters


When you are building integrations or audit workflows around Zoho Desk events, you often need to inspect an individual comment rather than paginating through the entire comment list. Fetching a single comment by its ID is faster, reduces payload size, and lets you confirm the exact state of a comment before deciding whether to update or delete it. This is also useful for displaying comment detail views inside custom portals or third-party dashboards.


Step-by-step


Step 1. Confirm your OAuth token includes the correct Zoho Desk events scope. The scope you need is Desk.events.READ (or the broader Desk.events.ALL). Without this scope the API will reject the request with an authorisation error. [2]


Step 2. Identify the two path parameters you will need:


  • eventId — the unique identifier of the parent event in Zoho Desk.
  • commentId — the unique identifier of the specific comment you want to retrieve.

If you do not already have the commentId, you can first call the list endpoint GET /api/v1/events/{eventId}/comments to enumerate all comments on the event and locate the one you need. [5]


Step 3. Send a GET request to the following endpoint, substituting your real IDs into the path:


GET /api/v1/events/{eventId}/comments/{commentId}

Include your OAuth bearer token in the Authorization header. The optional query parameter p can be passed as a dictionary if the API supports pagination or field-filtering options for this call. [1]


Step 4. In Python, if you are using a client wrapper, the call looks like this:


result = client.get_event_comment_details(
    eventId="your_event_id",
    commentId="your_comment_id"
)

The method issues the GET request to /api/v1/events/{eventId}/comments/{commentId} and returns the parsed response. The optional p argument accepts a dict of any additional query parameters you want to append. [1]


Step 5. Parse the response body. A successful call returns the comment detail object. If you need to modify the comment after reviewing it, use the PATCH /api/v1/events/{eventId}/comments/{commentId} endpoint with a data payload containing your changes. [3]


Common pitfalls


  • Wrong scope — Using only Desk.tickets.READ is not sufficient. Events and their comments require the Desk.events.READ or Desk.events.ALL scope to be present in your OAuth token. Double-check your scope configuration before debugging the request itself. [2]
  • Swapped IDs — The path requires eventId first and commentId second. Reversing them will result in a 404 or an unexpected record being returned. Always verify both IDs against the list endpoint before making the detail call. [1] [5]
  • Missing parent event — A commentId is only valid in the context of its parent eventId. A comment that belongs to event A cannot be retrieved by passing event B's ID, even if the comment ID itself is correct. [1]

What to check


  • Verify that your active OAuth token contains Desk.events.READ or Desk.events.ALL in its granted scopes before making the request. [2]
  • Confirm the eventId and commentId values by first calling GET /api/v1/events/{eventId}/comments and matching the comment in the returned list. [5]
  • If you intend to modify the comment after retrieval, ensure your token also includes Desk.events.UPDATE or Desk.events.ALL, since the update operation uses a separate PATCH call. [2] [3]

---


*Beam Help provides independent expert support for Zoho products and is not official Zoho support. Always refer to the Zoho Desk API documentation for the latest endpoint specifications.*

Sources cited

  1. [1] GET /api/v1/events/{eventId}/comments/{commentId}
  2. [2] config.py
  3. [3] PATCH /api/v1/events/{eventId}/comments/{commentId}
  4. [4] server.py: chat
  5. [5] GET /api/v1/events/{eventId}/comments
  6. [6] server.py: build_zoho_links
  7. [7] server.py: chat_plan
Get Event Comment Details in Zoho Desk | Beam Help — Beam Help