List comments on a deal

​

Lists the comments on one deal, newest first.

Comments always belong to a deal or a task, so there is no endpoint that lists them all — you read them per record. A deal you cannot see returns 404.

Two kinds of entry live in this thread: comments people wrote (user_created) and the activity Bonsai records on its own (event) — status changes, reassignments and the like. Only the written comments come back by default; use filter[kind] to get the activity entries instead, or both together.

Path Parameters
  • deal_id
    Type: string
    required

    The deal to read comments from — the deal's numeric id.

Query Parameters
  • filter[kind]
    Type: string enum

    Which entries to return: user_created for written comments (the default), events for the activity Bonsai records automatically, or all for both.

    values
    • user_created
    • events
    • all
  • page[number]
    Type: integer
    min:  
    1

    Page to return, starting at 1.

  • page[size]
    Type: integer
    min:  
    1
    max:  
    100

    Records per page. Defaults to 25; anything above 100 is reduced to 100.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/public-api/v1/deals/{deal_id}/comments
curl 'https://app.hellobonsai.com/public-api/v1/deals/{deal_id}/comments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 5821,
      "kind": "user_created",
      "commentable_type": "Task",
      "created_at": "2026-04-14T09:12:04.000Z",
      "body_plain_text": "Looks good to me!",
      "commentable_id": "ad3fdad8-5072-46df-8800-bb57299179df",
      "author_member_id": 314
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

A page of comments, newest first.