GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

countContacts

The number of active contacts visible to you, in one call.

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

The number of active contacts visible to you, in one call: the total the Contacts page shows (archived and hidden contacts excluded). Use it for any count-shaped question; never page through findContacts to count. With no arguments it is the total VISIBLE TO THE KEY OWNER, the org-wide total only for an owner holding VIEW_ALL_CONTACTS (applied with or without a filterTree), so never report it as the organization's total unless you know the owner sees every contact. Takes an optional filterTree (saveFilter's DSL), never filterId: a saved filter's count is filterContacts' total with its filterId. NEVER save a filter to measure one. A status word ("called", "hot", "dead") can name the org's own tags: searchContactTags for it before you count by an activity or system field alone, and count each reading you find. A count is the answer, 0 included: never re-derive it by paging. Archived contacts are excluded, so 0 means no ACTIVE match. To see how a condition treats empty values, run filterContacts once.

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

filterTreeJSON

Default {id: "root", operator: "AND", conditions: [], groups: []}.

Response

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

response shape
{
  "data": {
    "contactQuery": {
      "getContactsCount": 0
    }
  }
}

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.

READgetContactREADgetContactsPropertiesREADfindContactsByNoteREADsearchInteractionsREADfindContactsREADsearchContactTags