GoliathDevelopersGet an API key
Reference/Contactsgenerated from the gateway manifest

getContactsProperties

Many contacts' linked properties in ONE read.

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

Many contacts' linked properties in ONE read: contactIds in (a bulk selection's ids, up to 200), each contact's properties[] out (propertyString, and property.id, the property id a skip trace, export or PROPOSE_BULK_TASK selection takes; null when the address never matched a parcel, so it cannot be traced). Use it to turn contacts into their properties, never one getContact per contact. Every id must be one of this workspace's contacts (one outside it refuses the call); a contact you may not open is left out, and a merged id is not followed, so use the ids filterContacts or findContacts returned.

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

contactIds[ID!]!required

Response

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

response shape
{
  "data": {
    "contactQuery": {
      "getContacts": [
        {
          "id": "<ID>",
          "name": "…",
          "isArchived": true,
          "properties": [
            {
              "propertyString": "…",
              "status": "…",
              "property": {
                "id": "<ID>"
              }
            }
          ]
        }
      ]
    }
  }
}

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.

READgetContactREADfindContactsByNoteREADsearchInteractionsREADcountContactsREADfindContactsREADsearchContactTags