Moodle API: Complete Guide with Examples

What Is the Moodle API?

Moodle API Authentication

Step 1: Enable Web Services

1. Log in as a Moodle administrator
2. Go to Site Administration → Advanced features
3. Check "Enable web services" and save

Step 2: Enable the REST Protocol

1. Go to Site Administration → Plugins → Web services → Manage protocols
2. Enable REST protocol

Step 3: Create an API Token

Option A: User Token (Recommended for Testing)

1. Go to Site Administration → Plugins → Web services → Manage tokens
2. Click "Create token"
3. Select the user and the service
4. Save — you'll receive a token string

Option B: Token via Login

bashcurl "https://your-moodle.com/login/token.php?username=admin&password=yourpassword&service=moodle_mobile_app"

json{
  "token": "abc123def456..."
}

Step 4: Create a Web Service

1. Go to Site Administration → Plugins → Web services → External services
2. Click "Add"
3. Name your service and add the functions you need
4. Assign an authorized user

How to Use the Moodle API

Base URL Format

Example: Get Site Info

bashcurl "https://your-moodle.com/webservice/rest/server.php?wstoken=YOUR_TOKEN&wsfunction=core_webservice_get_site_info&moodlewsrestformat=json"

json{
  "sitename": "My Moodle Site",
  "username": "admin",
  "firstname": "Admin",
  "lastname": "User",
  "lang": "en",
  "userid": 2,
  "siteurl": "https://your-moodle.com",
  "release": "4.3 (Build: 20231009)",
  "version": "2023100900"
}

Key Moodle API Endpoints

User Management

Course Management

Enrolment

Grades

Quiz

Moodle REST API Examples

Create a User

bashcurl -X POST "https://your-moodle.com/webservice/rest/server.php" \
  -d "wstoken=YOUR_TOKEN" \
  -d "wsfunction=core_user_create_users" \
  -d "moodlewsrestformat=json" \
  -d "users[0][username]=jdoe" \
  -d "users[0][password]=SecurePass123!" \
  -d "users[0][firstname]=John" \
  -d "users[0][lastname]=Doe" \
  -d "users[0][email][email protected]"

Get All Courses

bashcurl "https://your-moodle.com/webservice/rest/server.php?wstoken=YOUR_TOKEN&wsfunction=core_course_get_courses&moodlewsrestformat=json"

Enrol a User in a Course

bashcurl -X POST "https://your-moodle.com/webservice/rest/server.php" \
  -d "wstoken=YOUR_TOKEN" \
  -d "wsfunction=enrol_manual_enrol_users" \
  -d "moodlewsrestformat=json" \
  -d "enrolments[0][roleid]=5" \
  -d "enrolments[0][userid]=3" \
  -d "enrolments[0][courseid]=2"

Get Enrolled Users

bashcurl "https://your-moodle.com/webservice/rest/server.php?wstoken=YOUR_TOKEN&wsfunction=core_enrol_get_enrolled_users&moodlewsrestformat=json&courseid=2"

Python Examples

Create Users in Bulk

pythonimport requests

MOODLE_URL = "https://your-moodle.com/webservice/rest/server.php"
TOKEN = "your_moodle_api_token"

users = [
    {"username": "student1", "firstname": "Alice", "lastname": "Smith", "email": "[email protected]", "password": "Pass123!"},
    {"username": "student2", "firstname": "Bob", "lastname": "Jones", "email": "[email protected]", "password": "Pass456!"},
]

params = {
    "wstoken": TOKEN,
    "wsfunction": "core_user_create_users",
    "moodlewsrestformat": "json",
}

for i, user in enumerate(users):
    for key, value in user.items():
        params[f"users[{i}][{key}]"] = value

response = requests.post(MOODLE_URL, data=params)
print(response.json())

Get All Courses

pythonresponse = requests.get(MOODLE_URL, params={
    "wstoken": TOKEN,
    "wsfunction": "core_course_get_courses",
    "moodlewsrestformat": "json"
})

courses = response.json()
for course in courses:
    print(f"{course['id']}: {course['fullname']}")

Importing Quizzes: Moodle API vs Formswrite API

How Formswrite Works with Moodle

1. Call the Formswrite API with your Google Doc and format: "moodle"
2. Download the generated Moodle XML file
3. Import into Moodle via Question Bank → Import

bash# Convert Google Doc to Moodle quiz
curl -X POST https://api.formswrite.com/api/v1/convert \
  -H "Authorization: Bearer FORMSWRITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documentId": "YOUR_DOC_ID", "format": "moodle"}'

Moodle API Documentation Resources

• Official docs: docs.moodle.org/dev/Web_services
• Function reference: Your Moodle site → Site Administration → Plugins → Web services → API Documentation
• Testing tool: Your Moodle site → Site Administration → Development → Web service test client

FAQ

What is the Moodle REST API?

How do I get a Moodle API token?

What can I do with the Moodle API?

Is the Moodle API free?

Can I create quiz questions via the Moodle API?

Summary