Skip to main content

List Properties

Retrieve a paginated list of custom properties for your organization.

Endpoint

GET /properties

Query Parameters

ParameterTypeDefaultDescription
limitnumber20Items per page (min: 1, max: 100)
afterstringCursor — return items after this id (exclusive).
beforestringCursor — return items before this id (exclusive).
searchstringSearch 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 "https://api.arsel.sa/v1/properties?limit=20" \
-H "Authorization: Bearer be_your_api_key"