Skip to main content

List Tags

Retrieve a paginated list of tags. Each tag includes a current contact_count.

Endpoint​

GET /tags

Returns: 200 OK

Headers​

HeaderValueRequired
AuthorizationBearer <your-api-key>Yes

Query Parameters​

ParameterTypeDefaultDescription
limitnumber20Items per page (min: 1, max: 100)
afterstring—Cursor — return items after this id (exclusive).
beforestring—Cursor — return items before this id (exclusive).
searchstring—Search by tag 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",
"description": "High-value customers eligible for special offers",
"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": "webinar-attendee",
"description": null,
"contact_count": 340,
"created_at": "2026-02-20T09:00:00.000Z",
"updated_at": "2026-02-20T09:00:00.000Z"
}
]
}

See Create Tag for the per-item field reference.


Examples​

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

Error Responses​

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