CentreCareOS API Documentation

# Copy to your project
curl -o centrecareos.js https://centrecareos.com/sdk/centrecareos.js

# Or use as an ES module in HTML
<script type="module">
  import { CentreCareOS } from 'https://centrecareos.com/sdk/centrecareos.js';
  const client = new CentreCareOS('ccapi_your_api_key_here');
</script>

import { CentreCareOS } from './centrecareos.js';

const client = new CentreCareOS('ccapi_your_api_key_here');

// List all students
const students = await client.students.list();
console.log(students);

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

// Create a student
const newStudent = await client.students.create({
  firstName: 'Emma',
  lastName: 'Johnson',
  dateOfBirth: '2021-03-15',
  roomId: 'room_id_here',
});

// Update a student
await client.students.update('student_id_here', {
  firstName: 'Emma',
  lastName: 'Smith',
});

// Check in a student
await client.attendance.checkIn({
  studentId: 'student_id_here',
  note: 'Dropped off by parent',
});

// Check out a student
await client.attendance.checkOut({
  studentId: 'student_id_here',
});

// List today's attendance
const records = await client.attendance.list({
  date: '2026-02-14',
});

// Billing
const invoices = await client.billing.listInvoices({ status: 'pending' });
const invoice = await client.billing.getInvoice('invoice_id');
const payments = await client.billing.listPayments();
const overview = await client.billing.getOverview();

// Rooms
const rooms = await client.rooms.list();
const room = await client.rooms.get('room_id');
await client.rooms.update('room_id', { capacity: 18 });

// Staff
const staff = await client.staff.list();
await client.staff.update('staff_id', { status: 'ACTIVE' });

// Parents and family links
const parents = await client.parents.list();
await client.parents.link('student_id', 'parent_id', 'Mother', true);

// Messaging
const conversations = await client.conversations.list();
await client.conversations.sendMessage('conversation_id', {
  content: 'Attendance sync completed successfully.',
});

// Operations
const waitlist = await client.waitlist.list();
const reportSummary = await client.dailyReports.summary({ date: '2026-02-14' });
const settings = await client.settings.get();

import { CentreCareOS, CentreCareOSError } from './centrecareos.js';

const client = new CentreCareOS('ccapi_your_api_key_here');

try {
  const students = await client.students.list();
} catch (err) {
  if (err instanceof CentreCareOSError) {
    console.error('API Error:', err.message);
    console.error('Status:', err.status);   // e.g. 403
    console.error('Code:', err.code);       // e.g. "INVALID_SCOPE"
  }
}

// Check rate limit status after any request
console.log('Remaining:', client.rateLimit.remaining);
console.log('Limit:', client.rateLimit.limit);