GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

findContactsByNote

Contacts by what their NOTES say; for calls, texts and emails too, use searchInteractions.

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

Contacts by what their NOTES say; for calls, texts and emails too, use searchInteractions. One row per contact with a ~100-char noteSnippet, not the body. Silent limits: notes from the LAST YEAR; 4+ characters of free text (not an email, phone or parcel id: use findContacts); at most 50 contacts from 500 candidate notes, so totalCount is that capped set and empty proves nothing.

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

limit is clamped to 50.

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.

searchTermString!required
limitInt

Default 20.

offsetInt

Default 0.

includeArchivedBoolean

Default false.

Response

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

response shape
{
  "data": {
    "contactQuery": {
      "getContactNoteResults": {
        "results": [
          {
            "contactId": "<ID>",
            "personName": "…",
            "noteSnippet": "…",
            "isArchived": true
          }
        ],
        "totalCount": 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.

READgetContactREADgetContactsPropertiesREADsearchInteractionsREADcountContactsREADfindContactsREADsearchContactTags