Search Contact List Contacts
Searches for contacts within a specific contact list using filters and sorting options. This endpoint supports multiple filter conditions, pagination, and flexible operators.
Endpoint
POST
v5/contactlist/{contact_list_id}/contactlistcontact/search
Requires authentication
Path Parameters
The contact list in which to search for contacts.
contact_list_id
string
required
The ID of the contact list to be searched.
Request Body
This endpoint accepts filters used to search contacts and sorting options.
filters
array
required
List of filter conditions used to match contact fields.
child attributes
field_name
string
The contact field to filter by (e.g.,
email, first_name).operator
string
The comparison operator used.
EQ |
Is equal to |
NEQ |
Is not equal to |
GT |
Greater than |
LT |
Less than |
LTE |
Less than or equal to |
GTE |
Greater than or equal to |
IS_NOT_NULL |
Is not blank |
IS_NULL |
Is blank |
IN |
In comma‑separated list |
value
string
The value to match against.
sort
object
Options used to sort the results.
child attributes
sort_by
string
Field to sort by (e.g.,
date_created).sort_order
string
Sorting direction:
ASC or DESC.Response
Returns matching contacts from the specified contact list.
result_ok
boolean
Whether the request was successful.
page
integer
Returned page number.
results_per_page
integer
Maximum number of results returned.
data
array
Array of contact objects matching the filter criteria.
child attributes
id
string
Unique contact ID.
email_address
string
Primary email address.
status
string
Current status (e.g., Active).
first_name
string
Contact's first name.
last_name
string
Contact's last name.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/contactlist/12345/contactlistcontact/search?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET" \
-H "Content-Type: application/json" \
-d '{
"filters": [
{
"field_name": "email",
"operator": "EQ",
"value": "justin@example.com"
},
{
"field_name": "first_name",
"operator": "EQ",
"value": "Justin"
}
],
"sort": {
"sort_by": "date_created",
"sort_order": "DESC"
}
}
Response
{
"result_ok": true,
"page": 1,
"results_per_page": 50,
"data": [
{
"id": "3267",
"email_address": "justin@example.com",
"status": "Active",
"first_name": "Justin",
"last_name": "Sample",
"organization": "",
"division": "",
"department": "",
"group": "",
"role": "",
"is_manager": "False",
"team": "",
"home_phone": "",
"fax_phone": "",
"business_phone": "",
"mailing_address": "",
"mailing_address2": "",
"mailing_address_city": "",
"mailing_address_state": "",
"mailing_address_postal": "",
"mailing_address_country": "",
"title": "",
"url": "",
"my_custom_field_name": "foo",
"another_custom_field_name": "bar"
}
]
}