GoliathDevelopersGet an API key
Reference/Propertiesgenerated from the gateway manifest

getProperty

Fetch one property by id.

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

Fetch one property by id: address, skip-trace status, signal recency, owner of record and mailing address (metadata, as the page shows them), and visible tags and lists (each { id, name, isEditable }). Lists include read-only system ingestion lists alongside your organization lists. Read lists BEFORE addPropertiesToList / removePropertiesFromList to answer "is it already on that list?"; only reuse a list ID for mutations when isEditable is true. Other organizations' private tags and lists are excluded.

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

propertyIdID!required

Response

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

response shape
{
  "data": {
    "property": {
      "fetchProperty": {
        "id": "<ID>",
        "address": {
          "line1": "…",
          "line2": "…",
          "city": "…",
          "state": "…",
          "zip": "…",
          "countyName": "…",
          "addressFull": "…"
        },
        "skipTraceStatus": "PROCESSING",
        "lastSkiptracedAt": "2026-01-01T00:00:00.000Z",
        "isStaleSkiptrace": true,
        "lastPropertySignalDate": "2026-01-01T00:00:00.000Z",
        "spicyLeadScore": 0,
        "tags": [
          {
            "id": "<ID>",
            "name": "…",
            "isEditable": true
          }
        ],
        "lists": [
          {
            "id": "<ID>",
            "name": "…",
            "isEditable": true
          }
        ],
        "metadata": {
          "nameOnDeedUnformatted": "…",
          "coOwnerNameOnDeedUnformatted": "…",
          "ownerAddressFull": "…"
        }
      }
    }
  }
}

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.

READgetPropertySignalsREADgetPropertyOwnersREADfindPropertiesREADlistPropertyFiltersREADlistFilterFoldersREADfilterProperties