List Properties

Retrieve a paginated list of custom properties for your organization.

Endpoint

GET /properties

Returns: 200 OK

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 field_key or display_name

Results are returned newest first. See Pagination for cursor details.

Response

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
      "field_key": "lifetime_value",
      "display_name": "Lifetime Value",
      "data_type": "number",
      "description": null,
      "fallback_value": "0",
      "created_at": "2026-03-01T10:00:00.000Z",
      "updated_at": "2026-03-08T12:00:00.000Z"
    }
  ]
}

See Create Property for the per-item field reference.

---

Examples

cURL

curl "https://api.arsel.sa/v1/properties?limit=20" \
  -H "Authorization: Bearer $ARSEL_API_KEY"

JavaScript

const response = await fetch("https://api.arsel.sa/v1/properties?limit=20", {
  headers: {
    Authorization: `Bearer ${process.env.ARSEL_API_KEY}`,
  },
});

const data = await response.json();
if (!response.ok) {
  throw new Error(`${data.name}: ${data.message}`);
}

console.log(data);

Python

import os

import requests

response = requests.get(
    "https://api.arsel.sa/v1/properties?limit=20",
    headers={"Authorization": f"Bearer {os.environ['ARSEL_API_KEY']}"},
)
response.raise_for_status()

print(response.json())

C#

using System.Net.Http.Headers;

var client = new HttpClient(); // share one instance across requests
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ARSEL_API_KEY"));

var response = await client.GetAsync("https://api.arsel.sa/v1/properties?limit=20");
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"{(int)response.StatusCode}: {body}");

Console.WriteLine(body);

PHP

<?php
$ch = curl_init("https://api.arsel.sa/v1/properties?limit=20");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("ARSEL_API_KEY"),
    ],
]);

$data = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
    throw new Exception("{$data['name']}: {$data['message']}");
}

print_r($data);

---

Error Responses

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid API Key"
}