List Segments

Retrieve a paginated list of the segments in your organization. A segment is a dynamic audience: the contacts that currently match a set of rules. Use a segment's id in the segment_ids of a campaign.

Segments are created and edited in the Arsel Dashboard. The API reads them; it does not return or change their rules.

Endpoint

GET /segments

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 segment 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": "VIP customers",
      "description": "Spent over 1,000 SAR in the last 90 days",
      "contact_count": 420,
      "counted_at": "2026-03-08T12:00:00.000Z",
      "created_at": "2026-03-01T10:00:00.000Z",
      "updated_at": "2026-03-02T09:30:00.000Z"
    },
    {
      "id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6b",
      "name": "New this week",
      "description": null,
      "contact_count": null,
      "counted_at": null,
      "created_at": "2026-03-08T11:55:00.000Z",
      "updated_at": "2026-03-08T11:55:00.000Z"
    }
  ]
}

Segment fields

Field	Type	Description
id	string	The segment ID
name	string	The segment name
description	string | null	Optional description
contact_count	number | null	Contacts matching the segment when it was last counted. null if it has not been counted yet, or its rules changed since.
counted_at	string | null	When contact_count was computed (ISO 8601)
created_at	string	When the segment was created (ISO 8601)
updated_at	string	When the segment was last changed (ISO 8601)

Counts are a snapshot

contact_count is not computed on request. Arsel recounts segments in the background, and resolves the audience again when a campaign is sent, so a campaign reaches whoever matches at send time.

---

Examples

cURL

curl "https://api.arsel.sa/v1/segments?limit=20" \
  -H "Authorization: Bearer be_your_api_key"

JavaScript

const response = await fetch(
  "https://api.arsel.sa/v1/segments?limit=20",
  {
    headers: { Authorization: "Bearer be_your_api_key" },
  }
);

const { data, has_more } = await response.json();
for (const segment of data) {
  console.log(`${segment.id}: ${segment.name} (${segment.contact_count ?? "not counted"})`);
}

Python

import requests

response = requests.get(
    "https://api.arsel.sa/v1/segments",
    headers={"Authorization": "Bearer be_your_api_key"},
    params={"limit": 20},
)

result = response.json()
for segment in result["data"]:
    print(segment["id"], segment["name"], segment["contact_count"])

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");

var response = await client.GetAsync("https://api.arsel.sa/v1/segments?limit=20");
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php
$ch = curl_init("https://api.arsel.sa/v1/segments?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);

---

Error Responses

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid or missing API key"
}