GET
/
v1
/
trace-learn
/
notifications
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.listTraceLearnNotifications({
  query: {},
})
[
  {
    "id": "<string>",
    "recipientId": "<string>",
    "recipientEmail": "<string>",
    "subject": "<string>",
    "sentAt": "<string>",
    "templateId": "<string>",
    "studentId": "<string>",
    "createdAt": "<string>",
    "readAt": "<string>"
  }
]

Query Parameters

​
role
enum<string>
Available options:
parent,
tutor

Response

Success

​
id
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
kind
enum<string>
required
Available options:
homework_completion,
homework_reminder,
weekly_digest,
six_weekly_summary,
paper_assigned,
paper_completed,
streak_milestone,
diagnostic_completed,
student_welcome,
subscription_payment_failed,
subscription_renewed
​
recipientRole
enum<string>
required
Available options:
parent,
tutor
​
recipientId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
recipientEmail
string
required
​
subject
string
required
​
status
enum<string>
required
Available options:
pending,
sent,
failed,
bounced
​
sentAt
string | null
required

a string at least 10 character(s) long

Minimum string length: 10
​
templateId
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
studentId
string | null
required

a string at most 128 character(s) long

Required string length: 1 - 128
​
createdAt
string
required

a string at least 10 character(s) long

Minimum string length: 10
​
readAt
string | null
required

a string at least 10 character(s) long

Minimum string length: 10