GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

getGoalPlan

Your goals for the month containing periodStartDate.

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

Your goals for the month containing periodStartDate (YYYY-MM-DD): draftPlan (being edited) and activePlan (published), either null. Commission goals are targetCents per pipeline (null pipelineId = all pipelines); metric EARNED counts won deals, TOTAL adds pending ones. Personal goals are free text. Your own plan; a teammate’s is the *Teammate* op (ADMIN).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getGoalPlan",
    "variables": {
      "periodStartDate": "2026-01-01"
    }
  }'
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.team.getGoalPlan({
  periodStartDate: '2026-01-01'
})
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: 'getGoalPlan',
    variables: {
      periodStartDate: '2026-01-01'
    }
  }),
})
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.

periodStartDateDate!required

Response

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

response shape
{
  "data": {
    "agentGoalsQuery": {
      "getAgentGoalPlan": {
        "draftPlan": {
          "id": "<ID>",
          "userId": "<ID>",
          "periodStartDate": "…",
          "periodEndDate": "…",
          "status": "DRAFT",
          "publishedAt": "2026-01-01T00:00:00.000Z",
          "commissionGoals": [
            {
              "id": "<ID>",
              "pipelineId": "<ID>",
              "pipelineName": "…",
              "metric": "EARNED",
              "targetCents": "…"
            }
          ],
          "personalGoals": [
            {
              "id": "<ID>",
              "title": "…",
              "description": "…",
              "status": "ACTIVE",
              "displayOrder": 0
            }
          ]
        },
        "activePlan": {
          "id": "<ID>",
          "userId": "<ID>",
          "periodStartDate": "…",
          "periodEndDate": "…",
          "status": "DRAFT",
          "publishedAt": "2026-01-01T00:00:00.000Z",
          "commissionGoals": [
            {
              "id": "<ID>",
              "pipelineId": "<ID>",
              "pipelineName": "…",
              "metric": "EARNED",
              "targetCents": "…"
            }
          ],
          "personalGoals": [
            {
              "id": "<ID>",
              "title": "…",
              "description": "…",
              "status": "ACTIVE",
              "displayOrder": 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.

READlistTeammatesREADlistTeamMembersREADgetTeammatesByIdsREADcountOutboundTextsREADgetTeamCallStatsREADgetMemberActivity