listFilterFieldNames
The COMPLETE vocabulary of filterable fields for a domain.
The COMPLETE vocabulary of filterable fields for a domain (CONTACT, PROPERTY or DEAL): every fieldId saveFilter accepts, with label, category and UI component. It always arrives whole, unlike the fuller listFilterFields, which drops WHOLE FIELDS when unnarrowed, so it is the only trustworthy answer to "is X filterable here?". Find the fieldId here, then call listFilterFields with those fieldIds for descriptions and value shapes. A field absent from THIS list is genuinely not filterable; never tell a user a filter is impossible from a truncated listFilterFields response or a rejected fieldId guess. Static schema introspection: reads no org data.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "listFilterFieldNames",
"variables": {
"type": "PROPERTY"
}
}'import { GoliathClient } from '@goliath-data/sdk'
const goliath = new GoliathClient({
apiKey: process.env.GOLIATH_API_KEY!,
baseUrl: 'https://server.goliathdata.com',
})
// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
type: 'PROPERTY'
} as Parameters<typeof goliath.properties.listFilterFieldNames>[0]
const result = await goliath.properties.listFilterFieldNames(variables)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: 'listFilterFieldNames',
variables: {
type: 'PROPERTY'
}
}),
})
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.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"filterQuery": {
"listFilterFields": [
{
"fieldId": "<ID>",
"label": "…",
"category": "…",
"component": "…"
}
]
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA 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.