API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Subjects

Create Subject

subjects.create(SubjectCreateParams**kwargs) -> SubjectCreateResponse

post/subjects

List Subjects

subjects.list(SubjectListParams**kwargs) -> SubjectListResponse

get/subjects

Get Subject

subjects.retrieve(strsubject_id) -> SubjectResource

get/subjects/{subject_id}

Update Subject

subjects.update(strsubject_id, SubjectUpdateParams**kwargs) -> SubjectResource

put/subjects/{subject_id}

Delete Subject

subjects.delete(strsubject_id) -> object

delete/subjects/{subject_id}

ModelsExpand Collapse

class SubjectResource: …

id: str

The ID of the subject.

created_at: datetime

The date and time the subject was created.

formatdate-time

email: Optional[str]

The email of the subject.

formatemail

external_id: Optional[str]

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

metadata: Dict[str, str]

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

name: Optional[str]

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