Skip to main content
GET
/
api
/
v1
/
lists
Lista list kontaktów
curl --request GET \
  --url https://api.example.com/api/v1/lists
{
  "success": true,
  "data": {
    "lists": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "is_active": true,
        "contact_count": 123,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "page": 123,
    "size": 123,
    "totalElements": 123,
    "totalPages": 123
  }
}

​
Parametry zapytania

​
page
integer
default:"0"
Numer strony dla paginacji (indeksowany od 0)
​
size
integer
default:"20"
Liczba list na stronę

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
Paginated lists data

​
Example request

curl https://api.mailist.com/api/v1/lists?page=0&size=20 \
  -H "X-API-Key: YOUR_API_KEY"

​
Example response

{
  "success": true,
  "data": {
    "lists": [
      {
        "id": 123,
        "name": "Newsletter Subscribers",
        "description": "Main newsletter subscription list",
        "is_active": true,
        "contact_count": 1250,
        "created_at": "2024-01-15T10:30:00",
        "updated_at": "2024-12-23T14:20:00"
      },
      {
        "id": 124,
        "name": "VIP Customers",
        "description": "Premium tier customers",
        "is_active": true,
        "contact_count": 87,
        "created_at": "2024-03-20T09:15:00",
        "updated_at": "2024-12-20T11:45:00"
      }
    ],
    "page": 0,
    "size": 20,
    "totalElements": 8,
    "totalPages": 1
  }
}

​
Uwagi

  • Listy są sortowane według daty utworzenia
  • Ten endpoint wymaga uprawnienia lists.read dla klucza API
  • Nieaktywne listy (is_active: false) nadal są zwracane w wynikach