GET
/
v1
/
learning
/
parent
/
children
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.listTraceLearnParentChildren()
[
  {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "targetSchool": "<string>",
    "credential": {
      "username": "<string>",
      "pinSet": true,
      "credentialKind": "student_username_pin",
      "lastRotatedAt": "<string>"
    },
    "link": {
      "id": "<string>",
      "parentId": "<string>"
    }
  }
]

Response

Success

id
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
displayName
string
required
avatarId
string
required

a string at most 128 character(s) long

Required string length: 1 - 128
yearGroup
enum<string>
required
Available options:
Year 4,
Year 5,
Year 6,
Other
targetSchool
string | null
required
credential
object
required