API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Subjects

Create Subject

post/subjects

List Subjects

get/subjects

Get Subject

get/subjects/{subject_id}

Update Subject

put/subjects/{subject_id}

Delete Subject

delete/subjects/{subject_id}

ModelsExpand Collapse

SubjectResource = object { id, created_at, email, 3 more }

id: string

The ID of the subject.

created_at: string

The date and time the subject was created.

formatdate-time

email: string

The email of the subject.

formatemail

external_id: string

The ID of the subject in your system. You may pass it to the API in place of the subject ID.

metadata: map[string]

Additional metadata about the subject. You may use this to store any custom data about the subject.

name: string

The name of the subject. Used for display in the dashboard.