Create List

POST

/lists

Create a new list.

Exactly one of categoryId or categoryName must be provided.

Request

Header Params

Body Params application/json

Examples

Responses

🟢201

application/json

Created

Bodyapplication/json

🟠404

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location '/lists' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Customers",
    "description": "Customers list",
    "order": 10,
    "categoryId": 1,
    "categoryName": "Marketing"
}'

Response Example

201 - Success

{
    "listId": 123,
    "name": "Customers",
    "description": "Customers list",
    "order": 10,
    "category": {
        "categoryId": 1,
        "name": "Marketing",
        "order": 1
    }
}

Modified at 2026-06-11 02:37:32

Get Lists

Get List