Get List
GET /v1/nexttask/lists/{id}
Get a list
One list you can reach.
Request
GET https://your-site.example/api/index.php/v1/nexttask/lists/{id}
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
id |
integer |
path |
Yes | The record the call is about. An id or ids in the body is ignored. |
Responses
200 — The list.
{
"success": true,
"message": "string",
"messages": "string",
"data": {
"item": {
"id": 5,
"user_id": 1,
"title": "Groceries",
"color": "#1967d2",
"position": "string",
"is_default": 1,
"is_team": 1,
"owner_name": "string",
"access": "owner",
"can_leave": true,
"created": "string",
"created_by": 1,
"modified": "string",
"modified_by": 1
}
}
}
Errors
| Status | Code | When |
|---|---|---|
401 |
No valid API token. | |
404 |
NOT_FOUND: no such record, or not one you can reach. |
Examples
curl
curl -s "https://your-site.example/api/index.php/v1/nexttask/lists/1" \
-H "X-Joomla-Token: $API_TOKEN"
PHP
<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nexttask/lists/1');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'X-Joomla-Token: ' . 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/nexttask/lists/1", {
headers: {
"X-Joomla-Token": `${API_TOKEN}`,
},
});
const data = await response.json();