Next Task REST API
Lists and tasks over Joomla's Web Services application, authenticated with Joomla's standard API token. A call acts as the token's user: it sees and changes exactly what that user can in the app, and what their roles allow applies here too.
Every answer from Next Task is JSON in the same envelope, success, data and
message, with a real HTTP status. Due dates are written in the site's time zone,
without a zone suffix.
Base URL
{protocol}://{host}{basePath}/api/index.php| Variable | Meaning | Example |
|---|---|---|
{protocol} |
Use http only for local development. | https |
{host} |
The host your Joomla site runs on. | your-site.example |
{basePath} |
Empty when Joomla is installed at the domain root. Otherwise the subfolder it is installed in, with a leading slash and no trailing slash. | (empty) |
Authentication
X-Joomla-Token: <your-api-token>The token from the user's Joomla API Token tab.
Endpoints
| Method | Operation | Purpose | Group |
|---|---|---|---|
GET |
/v1/nexttask/lists |
List your lists | Lists |
POST |
/v1/nexttask/lists |
Create a list | Lists |
GET |
/v1/nexttask/lists/{id} |
Get a list | Lists |
PATCH |
/v1/nexttask/lists/{id} |
Change a list | Lists |
DELETE |
/v1/nexttask/lists/{id} |
Delete a list | Lists |
GET |
/v1/nexttask/lists/{id}/members |
List a list's members | Lists |
GET |
/v1/nexttask/tasks |
List tasks | Tasks |
POST |
/v1/nexttask/tasks |
Create a task | Tasks |
POST |
/v1/nexttask/tasks/bulk |
Change several tasks | Tasks |
POST |
/v1/nexttask/tasks/star |
Star several tasks | Tasks |
GET |
/v1/nexttask/tasks/{id} |
Get a task | Tasks |
PATCH |
/v1/nexttask/tasks/{id} |
Change a task | Tasks |
DELETE |
/v1/nexttask/tasks/{id} |
Delete a task | Tasks |
POST |
/v1/nexttask/tasks/{id}/complete |
Complete or reopen a task | Tasks |
POST |
/v1/nexttask/tasks/{id}/move |
Move a task | Tasks |
POST |
/v1/nexttask/tasks/{id}/restore |
Restore a deleted task | Tasks |
Errors
| Status | Code | When |
|---|---|---|
401 |
No valid API token. | |
403 |
FORBIDDEN when the role or the list does not allow it, APP_DISABLED when the feature's app is off. |
|
422 |
VALIDATION, NESTING or QUOTA, with the reason in message. |
|
404 |
NOT_FOUND: no such record, or not one you can reach. |
See also
- Getting Started guide — enabling the API, screenshots and a worked end-to-end example