listStagesOfPipelines
Every owned and shared pipeline and its stages, in order.
Every owned and shared pipeline and its stages, in order; a large organization's answer is cut short. A stage by name is SEARCH_CONTEXT DEAL_STAGE (every pipeline; a miss is final), and every deal in it, in your own pipelines, findDeals stageName. Names repeat: move a deal only within its own pipeline.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "listStagesOfPipelines",
"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.listStagesOfPipelines()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: 'listStagesOfPipelines',
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": {
"currentUser": {
"myPipelines": [
{
"id": "<ID>",
"name": "…",
"stages": [
{
"id": "<ID>",
"name": "…",
"isTerminal": true
}
]
}
],
"sharedPipelines": [
{
"id": "<ID>",
"name": "…",
"sharedByOrganizationName": "…",
"stages": [
{
"id": "<ID>",
"name": "…",
"isTerminal": true
}
]
}
]
}
}
}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.