GoliathDevelopersGet an API key
Reference/Communicationsgenerated from the gateway manifest

getSendingLimits

How much can we text and email today? Per line, brand.

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

How much can we text and email today? Per line, brand (team) and mailbox: used / cap / remaining today (text segments; null cap = no limit; a mailbox also meters recipients, and the tighter of its two binds), a line's last-7-day volume, and the sending queue. Read-only. Count only lines with canSendSms and not isBurned. textingReadiness is the org's texting registration: canText, and reason when not (NO_REGISTRATION = none filed; MANAGED_* = Goliath-managed registration in review or failed; BYO_* = their own Twilio account). Read it first for a registration question; never fill in or submit one for them.

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

Variables

None. Send "variables": {}.

Response

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

response shape
{
  "data": {
    "currentUser": {
      "id": "<ID>",
      "organization": {
        "id": "<ID>",
        "textingReadiness": {
          "canText": true,
          "reason": "NO_REGISTRATION"
        },
        "twilioPhoneNumbers": [
          {
            "id": "<ID>",
            "e164Number": "…",
            "canSendSms": true,
            "isBurned": true,
            "smsDailyThrottle": {
              "used": 0,
              "cap": 0,
              "remaining": 0
            },
            "smsWarmUpVolume": {
              "last7Days": 0
            }
          }
        ],
        "smsBrandBudgets": [
          {
            "id": "<ID>",
            "phoneNumberIds": [
              "<ID>"
            ],
            "dailyThrottle": {
              "used": 0,
              "cap": 0,
              "remaining": 0,
              "utcDayEnd": "2026-01-01T00:00:00.000Z"
            }
          }
        ]
      }
    },
    "oauthQuery": {
      "myActiveEmailIdentities": [
        {
          "id": "<ID>",
          "email": "…",
          "dailyMessagesThrottle": {
            "used": 0,
            "cap": 0,
            "remaining": 0
          },
          "dailyRecipientsThrottle": {
            "used": 0,
            "cap": 0,
            "remaining": 0
          }
        }
      ]
    },
    "workflowAutomationsQuery": {
      "sendingQueue": {
        "queued": 0,
        "held": 0,
        "heldReason": "DAILY_CAP",
        "heldUntil": "2026-01-01T00:00:00.000Z",
        "nextSendAt": "2026-01-01T00:00:00.000Z"
      }
    }
  }
}

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.

READlistCommunicationChannelsREADgetMeetingTranscriptREADlistMeetingSummariesREADrenderContentTemplateREADgetSendConsentAttestationREADgetTextingRegistrationStatus