Skip to main content
GET
/
v1
/
cases
/
{case_token}
/
comments
List case comments
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/comments \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "cmt_7r3s1t5u",
      "case_token": "<string>",
      "author": {
        "user_id": "<string>",
        "name": "<string>",
        "initials": "<string>"
      },
      "type": "Comment",
      "body": "<string>",
      "mentions": [
        "<string>"
      ],
      "reactions": [
        {
          "emoji": "<string>",
          "user_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Path Parameters

​
case_token
string
required

Case token.

Query Parameters

​
cursor
string

Pagination cursor from a previous response. Pass to fetch the next page.

​
limit
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
type
enum<string>

Filter by comment type.

Available options:
Comment,
Decision,
Note,
System

Response

List of comments.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object