listPipelines
List the organization's deal pipelines with per-stage deal counts and values.
List the organization's deal pipelines with per-stage deal counts and values. Counts cover only deals you can see. total and stage value are WHOLE DOLLARS, not cents (1355000 is $1,355,000). Archived deals are excluded; a date window or a won total is findDeals totals. deals/total include won/lost stages; open is outcome open. sameNameCount is how many pipelines share the row's name: quote it, never count rows. Use the returned pipeline id with findDeals (its pipelineId filter) to list a pipeline's deals.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "listPipelines",
"variables": {}
}'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.listPipelines()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: 'listPipelines',
variables: {}
}),
})
const { data, errors } = await res.json()Variables
None. Send "variables": {}.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"pipelineSummaryQuery": {
"summaries": [
{
"id": "<ID>",
"name": "…",
"sameNameCount": 0,
"total": 0,
"deals": 0,
"stages": [
{
"name": "…",
"outcome": "…",
"count": 0,
"value": 0
}
]
}
]
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA 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.