Back to API DocsOfficial SDKs

SDKs & Libraries

Official client libraries for popular programming languages. Get started in minutes with type-safe, well-documented SDKs.

Choose your language

JavaScript / TypeScript SDK

Official SDK for Node.js and browser environments. Includes TypeScript definitions.

GitHub
npm install @classaddmin/sdk
Quick Start Example
// Install the SDK
npm install @classaddmin/sdk

// Initialize the client
import { ClassAddmin } from '@classaddmin/sdk';

const client = new ClassAddmin({
  apiKey: process.env.CLASSADDMIN_API_KEY,
});

// List students
const students = await client.students.list({
  status: 'active',
  limit: 20,
});

console.log(students.data);
// [{ id: 'uuid', first_name: 'Kwame', ... }, ...]

// Get a specific student
const student = await client.students.get('student-uuid');

// Create a new student
const newStudent = await client.students.create({
  first_name: 'Kofi',
  last_name: 'Asante',
  date_of_birth: '2015-06-20',
  gender: 'male',
  class_id: 'class-uuid',
});

// Mark attendance
await client.attendance.create({
  class_id: 'class-uuid',
  date: '2024-02-15',
  records: [
    { student_id: 'uuid-1', status: 'present' },
    { student_id: 'uuid-2', status: 'absent' },
  ],
});

// Send a message
await client.messages.send({
  type: 'sms',
  recipients: ['student-uuid-1', 'student-uuid-2'],
  message: 'School resumes Monday.',
});

Type Safe

Full type definitions for autocompletion and compile-time checks.

Zero Dependencies

Minimal footprint with no external dependencies required.

Well Documented

Comprehensive docs with examples for every method.

Need a different language?

We're always adding support for more languages. Let us know what SDK you need and we'll prioritize it.

Request an SDK