GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

getDealPipelineLayout

One pipeline's field layout.

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

One pipeline's field layout: each custom field with its display order, showOnCard and cardDisplayOrder (the up-to-5 fields the board card shows), and hiddenDetailFieldKeys (what the deal sheet and create/edit form hide: native:team|closeDate|dealValue|commission or custom:<fieldId>; null or empty = all shown). Read it before setDealCardFields or setDealDetailHiddenFields, which replace the whole list.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getDealPipelineLayout",
    "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.getDealPipelineLayout({
  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: 'getDealPipelineLayout',
    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": {
    "dealQuery": {
      "getDealPipeline": {
        "id": "<ID>",
        "name": "…",
        "canEditPipeline": true,
        "hiddenDetailFieldKeys": [
          "…"
        ],
        "customFields": [
          {
            "id": "<ID>",
            "name": "…",
            "type": "DROPDOWN",
            "displayOrder": 0,
            "showOnCard": true,
            "cardDisplayOrder": 0
          }
        ]
      }
    }
  }
}

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