GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

listDealCustomFields

List a deal pipeline's custom-field DEFINITIONS.

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

List a deal pipeline's custom-field DEFINITIONS (by pipelineId from listPipelines): id, name, type (TEXT/NUMBER/DOLLAR/DATE/LINK/DROPDOWN), dropdown options, allowMultiple, defaultValue. Deal custom fields are per-pipeline. DEFINITIONS ONLY: no deal's recorded value appears here: read those from getDeal's customFieldValues, which lists only the fields a given deal has been given a value for. Use each id as the customFieldId in the deal's customFieldValues input on createDeal / updateDeal to write values.

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

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.

pipelineIdID!required

Response

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

response shape
{
  "data": {
    "dealCustomFieldQuery": {
      "getPipelineCustomFields": [
        {
          "id": "<ID>",
          "name": "…",
          "type": "DROPDOWN",
          "options": [
            {
              "id": "<ID>",
              "label": "…"
            }
          ],
          "displayOrder": 0,
          "allowMultiple": true,
          "defaultValue": "…"
        }
      ]
    }
  }
}

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