Skip to main content

Get Segment

Retrieve a single segment by ID.

Endpoint​

GET /segments/:id

Headers​

HeaderValueRequired
AuthorizationBearer <your-api-key>Yes

Path Parameters​

ParameterTypeDescription
idstringThe segment ID

Response​

{
"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"
}

See List Segments for the field reference.


Examples​

curl "https://api.arsel.sa/v1/segments/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a" \
-H "Authorization: Bearer be_your_api_key"

Error Responses​

{
"status_code": 404,
"name": "not_found",
"message": "Segment with ID 01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a not found"
}