API Reference

VisCool API Reference

Build powerful integrations with the VisCool REST API.

Introduction

The VisCool API is a RESTful API that allows you to programmatically access and manage your institution's data. All requests and responses use JSON format.

Base URL

https://api.viscool.com/v1

Authentication

Authenticate your API requests using Bearer tokens. Include your API key in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are rate limited to 1,000 requests per minute per API key. Rate limit information is included in the response headers.

Students

The Students API lets you manage student records, enrollments, and academic data.

Endpoints

GET /v1/students

POST /v1/students

GET /v1/students/{id}

PUT /v1/students/{id}

DELETE /v1/students/{id}

Example Request

                    // List all students
curl -X GET https://api.viscool.com/v1/students \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
                

Example Response

                    {
  "data": [
    {
      "id": "stu_abc123",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "jane@example.com",
      "status": "active"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 25
  }
}
                

Courses

Manage courses, modules, and learning content through the Courses API.

GET /v1/courses

POST /v1/courses

GET /v1/courses/{id}

PUT /v1/courses/{id}

Enrollments

The Enrollments API handles student-course relationships and enrollment status.

GET /v1/enrollments

POST /v1/enrollments

SDKs & Libraries

Official client libraries are available for popular programming languages:

JavaScript / Node.js
Python
PHP
Ruby
C# / .NET