GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

listDealComments

One deal's comment thread, most-recent-first.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

One deal's comment thread, most-recent-first (the activity feed narrowed to COMMENT events, paged at the database: the full thread stays reachable however busy the rest of the feed is). The comment text is in the SuperJSON payload at json.body; actor identifies the commenter. Page with offset.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listDealComments",
    "variables": {
      "dealId": "<dealId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.deals.listDealComments({
  dealId: '<dealId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'listDealComments',
    variables: {
      dealId: '<dealId>'
    }
  }),
})
const { data, errors } = await res.json()

limit is clamped to 50.

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

dealIdID!required
limitInt

Default 50.

offsetInt

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "dealQuery": {
      "getDeal": {
        "id": "<ID>",
        "events": [
          {
            "id": "<ID>",
            "eventType": "STAGE_CHANGED",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "actor": {
              "userId": "<ID>",
              "name": "…"
            },
            "payload": "…"
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READgetDealREADfindDealsREADsurveyDealsREADlistStalledDealsREADlistPipelinesREADlistDealFilters