GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

listDealFiles

Files attached to a deal, most-recent-first: screenshots, recordings, documents.

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

Files attached to a deal, most-recent-first: screenshots, recordings, documents. Each entry carries id, fileName, contentType-bearing fileUrl and createdAt. fileUrl is a time-limited signed HTTPS URL: fetch it promptly and do not persist or share it, and re-read this op rather than caching the URL. Each URL is signed per file, so the page is small (limit defaults to 25 and is capped there): a full page means there may be more, so page with offset. This is the ONLY way to reach an attachment's bytes: a Slack-sourced deal records its attachments as a bare filename at the end of the description (Attachments: Screenshot ….png), which names the file but cannot open it. To ADD a file your org already holds (by its artifactId), use attachDealFile; to detach one, removeDealFile. Returns an empty list for a deal with no files, which is different from a deal you cannot see: a foreign or unknown dealId is refused at the gateway.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listDealFiles",
    "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.listDealFiles({
  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: 'listDealFiles',
    variables: {
      dealId: '<dealId>'
    }
  }),
})
const { data, errors } = await res.json()

limit is clamped to 25.

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 25.

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>",
        "files": [
          {
            "id": "<ID>",
            "fileName": "…",
            "fileUrl": "…",
            "createdAt": "2026-01-01T00:00:00.000Z"
          }
        ]
      }
    }
  }
}

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