Build on the Student Record

Quick Start

Your First Request in Five Minutes

Create a key in Settings, Developer. Keys are scoped to modules and campuses, and every call is logged in the audit trail.

• Base URL https://api.campusflow.io/v1
• Bearer authentication with scoped keys
• JSON in and out, UTC timestamps, cursor pagination
• Sandbox tenant included on Growth and above

curl https://api.campusflow.io/v1/enquiries \
  -H "Authorization: Bearer cf_live_9f3a..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Aarav Gupta",
    "phone": "+919876543210",
    "programme": "btech-cse",
    "source": "website",
    "campus": "pune-central"
  }'

HTTP/1.1 201 Created
{
  "id": "enq_01J8Z2K6W9",
  "stage": "new",
  "owner": "usr_counsellor_14",
  "created_at": "2026-10-04T09:12:44Z"
}

Reference

Resources You Can Read and Write

Webhooks

Events Delivered as They Happen

Register an endpoint, choose events, verify the signature header, and respond with 2xx within five seconds. Failed deliveries retry with backoff for 24 hours.

• enquiry.created, enquiry.stage_changed, enquiry.assigned
• payment.succeeded, payment.failed, refund.issued
• document.uploaded, document.verified, consent.withdrawn
• appointment.booked, appointment.completed

POST /your/endpoint
X-CampusFlow-Signature: t=1759568000,v1=5d41402a...

{
  "id": "evt_01J8Z3P0QF",
  "type": "payment.succeeded",
  "created_at": "2026-10-04T10:02:11Z",
  "data": {
    "payment_id": "pay_01J8Z3NZ7T",
    "student_id": "stu_01J7X0A4RM",
    "amount": 42500,
    "currency": "INR",
    "receipt_url": "https://pay.campusflow.io/r/8Hq2"
  }
}

Good to Know

Limits, Environments and Support

Building an Integration?

Tell us what you are connecting. Our integrations team will share reference implementations for your ERP, LMS or payment gateway.