API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Subjects

Create Subject

client.Subjects.New(ctx, body) (*SubjectNewResponse, error)

post/subjects

List Subjects

client.Subjects.List(ctx, query) (*SubjectListResponse, error)

get/subjects

Get Subject

client.Subjects.Get(ctx, subjectID) (*SubjectResource, error)

get/subjects/{subject_id}

Update Subject

client.Subjects.Update(ctx, subjectID, body) (*SubjectResource, error)

put/subjects/{subject_id}

Delete Subject

client.Subjects.Delete(ctx, subjectID) (*SubjectDeleteResponse, error)

delete/subjects/{subject_id}

ModelsExpand Collapse

type SubjectResource struct{…}

ID string

The ID of the subject.

CreatedAt Time

The date and time the subject was created.

formatdate-time

Email string

The email of the subject.

formatemail

ExternalID 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, 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.