Create List

POST /v1/nexttask/lists

Create a list

Needs Lists > Create.

Request

POST https://your-site.example/api/index.php/v1/nexttask/lists

Request body

Content type: application/json

{
    "title": "Groceries",
    "color": "#1967d2"
}

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

Examples

curl

curl -s -X POST "https://your-site.example/api/index.php/v1/nexttask/lists" \
  -H "X-Joomla-Token: $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Groceries","color":"#1967d2"}'

PHP

<?php
$ch = curl_init('https://your-site.example/api/index.php/v1/nexttask/lists');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-Joomla-Token: ' . getenv('API_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => '{"title":"Groceries","color":"#1967d2"}',
]);

$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", {
  method: 'POST',
  headers: {
    "X-Joomla-Token": `${API_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "Groceries",
    "color": "#1967d2"
  }),
});
const data = await response.json();