API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Subjects

Create Subject

client.subjects.create(SubjectCreateParams { email, external_id, metadata, name } body, RequestOptionsoptions?): SubjectCreateResponse { id, created_at, email, 3 more }

post/subjects

List Subjects

client.subjects.list(SubjectListParams { limit, offset } query?, RequestOptionsoptions?): SubjectListResponse { has_more, subjects }

get/subjects

Get Subject

client.subjects.retrieve(stringsubjectID, RequestOptionsoptions?): SubjectResource { id, created_at, email, 3 more }

get/subjects/{subject_id}

Update Subject

client.subjects.update(stringsubjectID, SubjectUpdateParams { email, metadata, name } body, RequestOptionsoptions?): SubjectResource { id, created_at, email, 3 more }

put/subjects/{subject_id}

Delete Subject

client.subjects.delete(stringsubjectID, RequestOptionsoptions?): SubjectDeleteResponse

delete/subjects/{subject_id}

ModelsExpand Collapse

SubjectResource { 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 | null

The email of the subject.

formatemail

external_id: string | null

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

metadata: Record<string, string>

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

name: string | null

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