Beam Help
Get help now

How-to · Zoho DESK

How to list event comments in Zoho Desk

Retrieve all comments associated with a specific event.

Listing event comments in Zoho Desk is straightforward once you have the correct API endpoint and the right OAuth scopes in place — a single GET request is all it takes.


Why this matters


If your team tracks activity logs, audit trails, or collaborative notes attached to Desk events, you'll need to retrieve those comments programmatically. This is common when building integrations, dashboards, or automated reporting workflows that surface event-level discussion without requiring agents to log into the Zoho Desk UI manually.


Step-by-step


Step 1. Confirm your OAuth scopes.

Before making any API call, verify that your connected application has been granted the Desk.events.READ scope (or the broader Desk.events.ALL). Without at least read-level access to events, the request will be rejected with an authorisation error. [1]


Step 2. Identify the target event ID.

You need the unique eventId for the event whose comments you want to retrieve. This identifier is returned when you create or list events in Zoho Desk, and it is a required path parameter for this endpoint. [7]


Step 3. Call the List Event Comments endpoint.

Send an HTTP GET request to the following path, substituting your actual event identifier:


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

The operation name is listeventcomments, and it accepts two parameters: eventId (required, in the path) and p (optional, a dictionary for any additional query parameters such as pagination). [7]


Step 4. Handle the response.

A successful call returns the comments associated with the specified event. Iterate over the response payload to extract comment content, authors, timestamps, or any other fields your integration requires. [7]


Step 5. (Optional) Paginate through results.

If an event has many comments, use the p parameter to pass pagination options — for example, page number or offset — so you retrieve the full set rather than just the first page. [7]


Python reference implementation


The underlying client method looks like this:


def list_event_comments(self, eventId: str, p: dict = None):
    """List Event Comments"""
    return self.c.request("GET", f"/api/v1/events/{eventId}/comments", p, None)

Pass p as a dictionary of query-string parameters when you need to control pagination or filtering. [7]


---


*Beam Help provides independent expert support for Zoho — we are not official Zoho support.*


Common pitfalls


  • Missing or insufficient scope. Using only Desk.tickets.READ will not grant access to event resources. Make sure Desk.events.READ or Desk.events.ALL is explicitly included in your OAuth scope string. [1]
  • Wrong data centre base URL. Zoho Desk is hosted across multiple data centres (US, EU, AU, IN, etc.). Ensure the base URL for your API requests matches the data centre where your Desk organisation is provisioned, or you will receive authentication or "organisation not found" errors.
  • Treating eventId as a ticket ID. Events and tickets are distinct entities in Zoho Desk. Passing a ticket ID to this endpoint will not return ticket comments — use the correct event identifier. [7]

What to check


  • Scope verification: Confirm that Desk.events.READ (or Desk.events.ALL) appears in your active OAuth token's granted scopes before going live. [1]
  • Endpoint path accuracy: Double-check that {eventId} in the request URL is replaced with a real, valid event ID from your Zoho Desk organisation. [7]
  • Pagination completeness: If the response includes a page indicator or a count that suggests more records exist, verify that your code iterates through all pages using the p parameter so no comments are silently dropped. [7]

Sources cited

  1. [1] config.py
  2. [2] server.py: chat_plan
  3. [3] server.py: build_zoho_links
  4. [4] server.py: chat
  5. [5] app.js
  6. [6] GET /api/v1/events/{eventId}/comments
List Event Comments in Zoho Desk | Beam Help — Beam Help