Next Restaurant 6.1.0: move your data in, run payroll, and connect other systems Next Inventory 6.2.0: a REST API and webhooks for your other systems Next DB 6.1: Auto-Updating Tables, Printing, Phone Layout and SEO Next Task 6.0.0: a task manager for Joomla Next Inventory 6.1.1: smoother Check Out, no more list limits, and much faster PHP2Shell: Is Your Joomla Site Safe? What to Do Today Introducing Next Boards: Kanban project and task boards for Joomla Building the Future of Joomla Extensions
NextSoftware
Next Exams — Documentation

Get Pass Grant

GET /v1/nextexams/passes/grants/{id}

Get a pass

Scope passes:read.

Request

GET https://your-site.example/api/index.php/v1/nextexams/passes/grants/{id}

Parameters

Name Type In Required Description
id integer path Yes The record's id. (min 1)

Responses

200 — The pass.

{
    "data": {
        "id": 1,
        "user_id": 1,
        "user_name": "string",
        "user_email": "string",
        "plan_id": 1,
        "plan_title": "string",
        "source": "string",
        "source_ref": "string",
        "starts_at": "2026-01-01T12:00:00Z",
        "expires_at": "2026-01-01T12:00:00Z",
        "status": "active",
        "created": "2026-01-01T12:00:00Z"
    }
}
Field Type Meaning
data.id integer
data.user_id integer
data.user_name string|null
data.user_email string|null
data.plan_id integer
data.plan_title string|null
data.source string manual, api, or ext:<element> for a pass an extension granted.
data.source_ref string|null The caller's own reference, unique per source.
data.starts_at string|null ISO 8601 in UTC, or null when not set. (date-time)
data.expires_at string|null ISO 8601 in UTC, or null when not set. (date-time)
data.status string One of active, expired, revoked.
data.created string|null ISO 8601 in UTC, or null when not set. (date-time)

Errors

Status Code When
401 INVALID_TOKEN No token (MISSING_TOKEN), or one that is wrong, expired, revoked, or whose owner can no longer sign in (INVALID_TOKEN).
403 MISSING_SCOPE The token is valid but this request is not allowed, and code says why: MISSING_SCOPE (the token lacks the scope), FORBIDDEN (the owner's role does not allow it), ACCESS_DENIED (the owner cannot manage Next Exams), API_DISABLED (the API Tokens app is off), APP_DISABLED (the feature's app is off — meta.app names it), ACCOUNT_UNUSABLE (the owner is blocked or must reset their password), DEMO_LOCKED (a demo site).
404 NOT_FOUND No record has this id.

Examples

curl

curl -s "https://your-site.example/api/index.php/v1/nextexams/passes/grants/1" \
  -H "Authorization: Bearer $API_TOKEN"

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nextexams/passes/grants/1');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('API_TOKEN'),
    ],
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

JavaScript

const API_TOKEN = process.env.API_TOKEN;

const response = await fetch("https://your-site.example/api/index.php/v1/nextexams/passes/grants/1", {
  headers: {
    "Authorization": `Bearer ${API_TOKEN}`,
  },
});
const data = await response.json();

All Extensions