GoliathDevelopersGet an API key
Reference/Propertiesgenerated from the gateway manifest

getFilter

Fetch ONE saved filter by id, including its full root criteria tree.

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

Fetch ONE saved filter by id, including its full root criteria tree: the only operation that returns the tree (listPropertyFilters / listContactFilters / listDealFilters return metadata only). Works for contact, property and deal filters. Call this BEFORE updateFilter whenever you are changing PART of a filter: updateFilter replaces root wholesale, so without reading the current tree first you would be re-authoring it blind and would silently drop every condition you didn't know was there. Read it, modify the one condition you mean to change, and send the modified tree back. The tree is saveFilter's DSL. Tag and list conditions hold ids: name them via searchContactTags (searchPropertyTags for PROPERTY). queryOptions (PROPERTY only) holds execution options outside the tree: { includeIncompleteRecords: true } runs the filter with the completeness gate OFF (~39% more of the index), which is why a count can exceed what the tree explains.

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

filterIdID!required

Response

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

response shape
{
  "data": {
    "filterQuery": {
      "getFilter": {
        "id": "<ID>",
        "name": "…",
        "type": "PROPERTY",
        "description": "…",
        "folderId": "<ID>",
        "root": "…",
        "queryOptions": "…",
        "isPrivate": true,
        "isDefault": true,
        "userId": "…",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      }
    }
  }
}

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.

READgetPropertyREADgetPropertySignalsREADgetPropertyOwnersREADfindPropertiesREADlistPropertyFiltersREADlistFilterFolders