GoliathDevelopersGet an API key
Reference/Contractsgenerated from the gateway manifest

listContractTemplates

The organization's contract templates.

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

The organization's contract templates: name, category, status (only a PUBLISHED one with a currentVersionNumber can be sent), signer roles in signing order, and the records a send asks for (uses: Contact A, Contact B, Deal, Property), and how many contracts went out from it (sentCount) and came back signed (signedCount). Archived ones only with includeArchived.

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

includeArchivedBoolean

Response

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

response shape
{
  "data": {
    "contractsQuery": {
      "templates": [
        {
          "id": "<ID>",
          "name": "…",
          "category": "…",
          "status": "DRAFT",
          "currentVersionNumber": 0,
          "signerRoles": [
            "…"
          ],
          "uses": [
            "…"
          ],
          "sentCount": 0,
          "signedCount": 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.

READlistContractsREADlistContactContractsREADlistDealContractsREADgetContractREADgetContractSendDraftREADgetHeldContractDraft