GET
/
v1
/
trace-learn
/
settings
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.getTraceLearnSettings()
{
  "profile": {
    "displayName": "<string>",
    "yearGroup": "<string>",
    "targetSchool": "<string>",
    "email": "<string>"
  },
  "learning": {
    "soundEffects": true,
    "streakReminders": true,
    "reducedMotion": true,
    "highContrast": true
  },
  "notifications": {
    "homeworkReminders": true,
    "completionEmails": true,
    "weeklyParentDigest": true,
    "quietHoursStart": "<string>",
    "quietHoursEnd": "<string>"
  },
  "reporting": {
    "autoSendReportsToParents": true,
    "requireTutorReviewBeforeShare": true
  },
  "billing": {
    "planLabel": "<string>",
    "learnerLimit": 123
  }
}

Response

Success

profile
object
required
learning
object
required
notifications
object
required
reporting
object
required
billing
object
required