List Lists
Retrieve a paginated list of all contact lists in your organization.
Endpoint
GET /lists
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <your-api-key> | Yes |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | number | 20 | Items per page (min: 1, max: 100) |
after | string | — | Cursor — return items after this id (exclusive). |
before | string | — | Cursor — return items before this id (exclusive). |
search | string | — | Search by list name |
Results are returned newest first. See Pagination for cursor details.
Response
{
"object": "list",
"has_more": false,
"data": [
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"name": "Newsletter Subscribers",
"description": "Contacts who opted in for weekly newsletter",
"contact_count": 1250,
"created_at": "2026-03-01T10:00:00.000Z",
"updated_at": "2026-03-08T12:00:00.000Z"
},
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6b",
"name": "Trial Users",
"description": null,
"contact_count": 87,
"created_at": "2026-02-15T08:00:00.000Z",
"updated_at": "2026-02-15T08:00:00.000Z"
}
]
}
See Create List for the per-item field reference.
Examples
- cURL
- JavaScript
- Python
- C#
- PHP
curl "https://api.arsel.sa/v1/lists?limit=20" \
-H "Authorization: Bearer be_your_api_key"
const response = await fetch(
"https://api.arsel.sa/v1/lists?limit=20",
{
headers: { Authorization: "Bearer be_your_api_key" },
}
);
const { data, has_more } = await response.json();
console.log(`Got ${data.length} lists; more available: ${has_more}`);
for (const list of data) {
console.log(`${list.id}: ${list.name}`);
}
import requests
response = requests.get(
"https://api.arsel.sa/v1/lists",
headers={"Authorization": "Bearer be_your_api_key"},
params={"limit": 20},
)
result = response.json()
for lst in result["data"]:
print(f"{lst['id']}: {lst['name']}")
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");
var response = await client.GetAsync("https://api.arsel.sa/v1/lists?limit=20");
Console.WriteLine(await response.Content.ReadAsStringAsync());
<?php
$ch = curl_init("https://api.arsel.sa/v1/lists?limit=20");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
echo $response;
curl_close($ch);