Get Lists

GET

/lists

Fetch lists with optional filters for category and name.

Request

Query Params

Header Params

Responses

🟢200

application/json

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location '/lists?categoryId=1&q=Customers&limit=10&offset=0' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "lists": [
        {
            "listId": 123,
            "name": "Customers",
            "description": "Customers list",
            "order": 10,
            "category": {
                "categoryId": 1,
                "name": "Marketing",
                "order": 1
            }
        }
    ],
    "paging": {
        "offset": 21,
        "limit": 40,
        "totalItems": 100,
        "totalPages": 5,
        "links": [
            "href: `?offset=40&limit=60`",
            "rel: `next`"
        ]
    }
}

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

Delete notification

Create List