Skip to main content

List Contacts

Retrieve your contacts with pagination, search, filtering, and sorting. You can also fetch a single contact by ID.

List All Contacts

Retrieve a paginated list of contacts in your organization.

Endpoint

GET /contacts

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 across email, first name, and last name
list_idstringFilter by contact list ID
tag_idstringFilter by tag ID

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

Response

{
"object": "list",
"has_more": true,
"data": [
{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"email": "john.doe@example.com",
"phone_number": "+201234567890",
"first_name": "John",
"last_name": "Doe",
"source": "api",
"properties": {
"company": "Acme Inc"
},
"is_suppressed": false,
"created_at": "2026-03-01T10:00:00.000Z",
"updated_at": "2026-03-08T12:00:00.000Z"
}
]
}

See Create Contact for the per-item field reference.


Examples

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

# Next page — pass the id of the last item from the previous response as `after`
curl "https://api.arsel.sa/v1/contacts?limit=20&search=john&after=01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a" \
-H "Authorization: Bearer be_your_api_key"

Filter by List

curl "https://api.arsel.sa/v1/contacts?list_id=01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a&limit=50" \
-H "Authorization: Bearer be_your_api_key"

Filter by Tag

curl "https://api.arsel.sa/v1/contacts?tag_id=01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6b&limit=50" \
-H "Authorization: Bearer be_your_api_key"

Get Contact Details

Retrieve a single contact by ID.

Endpoint

GET /contacts/:id

Path Parameters

ParameterTypeDescription
idstringThe contact ID

Response

Returns the same shape as Create Contact.

{
"id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
"email": "john.doe@example.com",
"phone_number": "+201234567890",
"first_name": "John",
"last_name": "Doe",
"source": "api",
"properties": {
"company": "Acme Inc",
"job_title": "Software Engineer",
"city": "Cairo"
},
"is_suppressed": false,
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-03-08T12:00:00.000Z"
}

Examples

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