getScheduledTask

One scheduled task by id (listScheduledTasks): its instruction (what Ask Goliath is told on every run), cronExpression and timezone (a one-off has oneOffAt), abilities (actions its runs may take without asking), expiresAt, notifyOnlyOnChange, its chat (sessionId) and whether it is running now.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getScheduledTask",
    "variables": {
      "taskId": "<taskId>"
    }
  }'

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.scheduledTasks.getScheduledTask({
  taskId: '<taskId>'
})

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: 'getScheduledTask',
    variables: {
      taskId: '<taskId>'
    }
  }),
})
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.

taskIdID!required

Response

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

response shape

{
  "data": {
    "scheduledTaskQuery": {
      "scheduledTask": {
        "id": "<ID>",
        "title": "…",
        "instruction": "…",
        "status": "ACTIVE",
        "cadence": "ONE_OFF",
        "cronExpression": "…",
        "timezone": "…",
        "oneOffAt": "2026-01-01T00:00:00.000Z",
        "schedule": "…",
        "nextRunAt": "2026-01-01T00:00:00.000Z",
        "lastRunAt": "2026-01-01T00:00:00.000Z",
        "runCount": 0,
        "ownerUserId": "<ID>",
        "ownerName": "…",
        "sessionId": "<ID>",
        "abilities": [
          "…"
        ],
        "tags": [
          "…"
        ],
        "expiresAt": "2026-01-01T00:00:00.000Z",
        "notifyOnlyOnChange": true,
        "createdAt": "2026-01-01T00:00:00.000Z",
        "mine": true,
        "canEdit": true,
        "running": 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.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "getScheduledTask", "variables": { "taskId": "<taskId>" } }'

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.scheduledTasks.getScheduledTask({ taskId: '<taskId>' })

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: 'getScheduledTask', variables: { taskId: '<taskId>' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related