Contents
On this page

List Grade Scales - Plugixa Exam

GET /plugixa-exam/v1/gradebook/scales

List the grade scales the gradebook uses to turn a percentage into a band such as A or B.

Scope attempts:read; the token’s user needs the attempts:view permission. It needs Plugixa Exam Pro with the Gradebook app on in Plugixa Exam -> App Manager: with the app off, the route answers 404.

Note. Read-only. Creating, editing and deleting scales are settings, and are not reachable by any token. The list is not paged: it returns up to 100 scales, by id.

Request

GET https://your-site.example/wp-json/plugixa-exam/v1/gradebook/scales

Responses

200 OK. data is the grade scales.

{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "Letter grades",
      "description": "A five-band scale. Change the boundaries, the names and the points to match your institution.",
      "bands": [
        { "label": "A", "min": 80, "points": 4, "colour": "#2e7d32" },
        { "label": "B", "min": 70, "points": 3, "colour": "#558b2f" },
        { "label": "C", "min": 60, "points": 2, "colour": "#f9a825" },
        { "label": "D", "min": 50, "points": 1, "colour": "#ef6c00" },
        { "label": "F", "min": 0, "points": 0, "colour": "#c62828" }
      ],
      "is_default": true,
      "published": true,
      "created_at": "2026-11-01 10:00:00",
      "modified_at": "2026-11-01 10:00:00",
      "created_by": 1,
      "modified_by": 1,
      "deleted_at": null
    }
  ]
}
Field Type Meaning
data[].id integer The scale’s id
data[].title string The scale’s name
data[].description string Its description
data[].bands object[] The bands, highest min first
data[].bands[].label string The band’s name, for example A
data[].bands[].min number The lowest percentage in this band
data[].bands[].points number Grade points for this band
data[].bands[].colour string Display colour, hex
data[].is_default boolean Whether this is the site’s default scale
data[].published boolean Whether the scale is published
data[].created_at string UTC datetime
data[].deleted_at string|null null unless the scale is in the trash

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-exam/v1/gradebook/scales" \
  -H "Authorization: Bearer $PLUGIXA_EXAM_TOKEN"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-exam/v1/gradebook/scales');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('PLUGIXA_EXAM_TOKEN'),
    ],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-exam/v1/gradebook/scales', {
  headers: {
    'Authorization': `Bearer ${process.env.PLUGIXA_EXAM_TOKEN}`,
  },
});
const { data } = await response.json();

Quick Links

Share