GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

filterContacts

Run a contact filter and paginate the matches with limit/offset.

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

Run a contact filter and paginate the matches with limit/offset. Returns a page of contacts (name, tags, phones, emails, doNotContact, reason, date, linked properties: no getContact per row) plus total and hasMore. Pass EITHER filterId (a saved filter from listContactFilters) OR filterTree (saveFilter's filter-tree DSL; conditions key fieldId, not field) to run an UNSAVED tree: same path and totals, nothing saved. filterTree verifies a filter before creating it and settles what a condition does (fetch a record with no value for the field and see whether the tree returns it). NEVER save a filter to measure one; save only the one asked for. Sort with sort: { field, direction } (ASC / DESC); field is a CLOSED vocabulary: NAME (A-Z), SELLER_INTENT_SCORE, LAST_COMMUNICATION, LAST_ACTIVITY, DIAL_ATTEMPTS (org-wide dials), MY_LAST_CALL, MY_LAST_TEXT, LAST_UPDATED, CREATED_AT, TASK_HIGHLIGHT, AUCTION_DATE (earliest upcoming auction; none sort last). Any other field is silently IGNORED. participants: its assignees (REVOKED: no longer assigned).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "filterContacts",
    "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.contacts.filterContacts({})
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: 'filterContacts',
    variables: {}
  }),
})
const { data, errors } = await res.json()

limit is clamped to 100.

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
filterTreeJSON
limitInt

Default 25.

offsetInt

Default 0.

sortSort
fieldString!required
directionSortDirection!required
ASCDESC

Response

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

response shape
{
  "data": {
    "contactQuery": {
      "paginateContacts": {
        "items": [
          {
            "id": "<ID>",
            "name": "…",
            "sellerIntentScore": 0,
            "isArchived": true,
            "doNotContact": true,
            "doNotContactReason": "…",
            "doNotContactSetAt": "2026-01-01T00:00:00.000Z",
            "tags": [
              {
                "id": "<ID>",
                "name": "…"
              }
            ],
            "phoneNumbers": [
              {
                "phoneNumber": "…",
                "suppressedMediums": [
                  "SMS"
                ]
              }
            ],
            "emails": [
              {
                "email": "…"
              }
            ],
            "participants": [
              {
                "status": "REVOKED",
                "user": {
                  "firstName": "…",
                  "lastName": "…"
                }
              }
            ],
            "properties": [
              {
                "propertyString": "…",
                "verificationStatus": "VERIFIED",
                "property": {
                  "id": "<ID>"
                }
              }
            ]
          }
        ],
        "pagination": {
          "total": 0,
          "hasMore": true
        }
      }
    }
  }
}

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.

READgetContactREADgetContactsPropertiesREADfindContactsByNoteREADsearchInteractionsREADcountContactsREADfindContacts