List Contact List Contacts
Returns a paginated list of all contacts in a specified contact list.
Endpoint
GET
v5/contactlist/{list_id}/contactlistcontact
Requires authentication
Path Parameters
The contact list whose contacts should be retrieved.
list_id
string
required
The ID of the contact list.
Query Parameters
All query parameters are optional.
page
integer
Page number to return. Defaults to 1.
resultsperpage
integer
Number of results to return per page. Default is 50, maximum is 500.
Response
Returns a paginated array of contact objects.
result_ok
boolean
Whether the request succeeded.
page
integer
Current page index.
results_per_page
integer
Number of results returned per page.
data
array
Array of contact objects.
child attributes
id
integer
The unique ID of the contact.
email_address
string
The contact's email address.
status
string
The contact's status. Values:
Active, Inactive.first_name
string
The contact's first name.
last_name
string
The contact's last name.
organization
string
The contact's organization.
division
string
The contact's division.
department
string
The contact's department.
group
string
The contact's group.
role
string
The contact's role.
is_manager
boolean
Whether the contact is a manager.
team
string
The contact's team.
home_phone
string
The contact's home phone number.
fax_phone
string
The contact's fax number.
business_phone
string
The contact's business phone number.
mailing_address
string
The contact's mailing address (line 1).
mailing_address2
string
The contact's mailing address (line 2).
mailing_address_city
string
The contact's city.
mailing_address_state
string
The contact's state or province.
mailing_address_postal
string
The contact's postal or ZIP code.
mailing_address_country
string
The contact's country code. Example:
US.title
string
The contact's job title.
url
string
The contact's website URL.
Examples
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/contactlist/YOUR_LIST_ID/contactlistcontact?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"page": 1,
"results_per_page": 50,
"data": [
{
"id": 100039752,
"email_address": "jon.doe@example.com",
"status": "Active",
"first_name": "Jon",
"last_name": "Doe",
"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": ""
}
]
}