GoliathDevelopersGet an API key
Reference/Notificationsgenerated from the gateway manifest

listCatchUpCards

The key owner's Catch up deck, ranked as the app deals it.

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

The key owner's Catch up deck, ranked as the app deals it: each card's id, kind, the sentence it asks (ask, else title), its rows (bundleRows, each defaultChecked) and suggestionIds. nextCursor continues the same ranking. What decideCatchUpCard takes.

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

limit is clamped to 200.

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.

limitInt

Default 50.

afterString

Response

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

response shape
{
  "data": {
    "dashboardQuery": {
      "workThroughQueue": {
        "total": 0,
        "nextCursor": "…",
        "cards": [
          {
            "id": "<ID>",
            "family": "MESSAGE",
            "kind": "…",
            "contactId": "<ID>",
            "title": "…",
            "ask": "…",
            "why": "…",
            "primaryLabel": "…",
            "estSeconds": 0,
            "costCredits": 0,
            "records": 0,
            "suggestionIds": [
              "<ID>"
            ],
            "bundleRows": [
              {
                "suggestionId": "<ID>",
                "contactId": "<ID>",
                "label": "…",
                "sublabel": "…",
                "defaultChecked": true,
                "kind": "…"
              }
            ]
          }
        ]
      }
    }
  }
}

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.

READlistNotificationsREADgetNotificationCountsREADgetAvailableNotificationTypesWRITEmarkNotificationsReadWRITEsetEmailDigestCadenceWRITEmarkAllNotificationsRead