GoliathDevelopersGet an API key
Reference/Contractsgenerated from the gateway manifest

getContract

One contract.

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

One contract: its values, each signer's status (viewed, signed, declined with their reason, a deliveryProblem when their link never arrived) and short-lived PDF links (signedPdfUrl once everyone signed). READY means prepared but not sent. Send, Remind, Correct and Void are buttons on /contracts/<id> (and, for a developer-API key, sendContract, remindContract, correctContract, voidContract).

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

contractIdID!required

Response

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

response shape
{
  "data": {
    "contractsQuery": {
      "contract": {
        "id": "<ID>",
        "title": "…",
        "category": "…",
        "status": "PREPARING",
        "held": true,
        "contactId": "<ID>",
        "contactName": "…",
        "revisionNumber": 0,
        "subject": "…",
        "message": "…",
        "expiryDays": 0,
        "reminderIntervalDays": 0,
        "sentAt": "2026-01-01T00:00:00.000Z",
        "expiresAt": "2026-01-01T00:00:00.000Z",
        "completedAt": "2026-01-01T00:00:00.000Z",
        "unsignedPdfUrl": "…",
        "signedPdfUrl": "…",
        "deal": {
          "id": "<ID>",
          "title": "…"
        },
        "values": [
          {
            "key": "<ID>",
            "label": "…",
            "value": "…"
          }
        ],
        "recipients": [
          {
            "id": "<ID>",
            "roleLabel": "…",
            "kind": "SIGNER",
            "displayName": "…",
            "email": "…",
            "phone": "…",
            "signingOrder": 0,
            "status": "WAITING",
            "firstViewedAt": "2026-01-01T00:00:00.000Z",
            "signedAt": "2026-01-01T00:00:00.000Z",
            "declinedAt": "2026-01-01T00:00:00.000Z",
            "declineReason": "…",
            "deliveryProblem": "…"
          }
        ]
      }
    }
  }
}

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.

READlistContractTemplatesREADlistContractsREADlistContactContractsREADlistDealContractsREADgetContractSendDraftREADgetHeldContractDraft