GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

listDealActivity

One deal's activity feed, most-recent-first.

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

One deal's activity feed, most-recent-first: the audit trail behind "who changed the price on this deal, and when did it get reassigned?". Each event carries eventType, createdAt, actor (the person, null for system/automation), and a SuperJSON payload whose json object holds the per-eventType detail. Pass eventTypes to narrow to the types you care about: a narrowed read pages at the DATABASE, so a sparse type's full history stays reachable however busy the rest of the feed is; omit it for the mixed feed, which caps at the 200 most recent events. Page with offset. THE FULL eventType VOCABULARY, with the payload keys under payload.json for each (there is no schema expansion for a SuperJSON scalar, so this text is the only description of the shape). The title and names are not in the payload: read the contract for them). Those nineteen are the whole vocabulary: an eventType outside this list does not exist. What the feed does NOT record is edits to a deal's title, description or custom-field values: no event type covers them, so their history is not reconstructable here.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listDealActivity",
    "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.listDealActivity({
  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: 'listDealActivity',
    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
eventTypes[PipelineItemActivityEventType!]
STAGE_CHANGEDVALUE_CHANGEDCOMMISSION_CHANGEDTEAM_SPLIT_CHANGEDCLOSE_DATE_CHANGEDASSIGNEDUNASSIGNEDCONTACT_LINKEDCONTACT_UNLINKEDTASK_ADDEDTASK_COMPLETEDFILE_ADDEDFILE_REMOVEDPIPELINE_ITEM_CREATEDDEAL_CREATEDPIPELINE_ITEM_ARCHIVEDDEAL_ARCHIVEDPIPELINE_ITEM_RESTOREDDEAL_RESTOREDCOMMENTSCRAPER_HEALTH_MOVEDCONTRACT_EVENT

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": "…",
            "taskNow": "…"
          }
        ]
      }
    }
  }
}

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