List Survey Contacts
Returns a list of all contacts for the specified survey campaign.
Endpoint
GET
v5/survey/{survey_id}/surveycampaign/{campaign_id}/surveycontact
Requires authentication
Path Parameters
The survey and campaign whose contacts should be retrieved.
survey_id
string
required
The ID of the survey.
campaign_id
string
required
The ID of the survey campaign.
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 list of contact objects for the campaign.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of contacts in the campaign.
page
integer
Current page index.
total_pages
integer
Number of available pages.
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. Used as the unique key per account.
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.
team
string
The contact's team.
group
string
The contact's group.
role
string
The contact's role.
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.
mobilephone
string
The contact's mobile phone number.
mailing_address
string
The contact's street address.
mailing_address2
string
The contact's secondary address line (e.g. suite number).
mailing_address_city
string
The contact's city.
mailing_address_state
string
The contact's state or region.
mailing_address_country
string
The contact's country.
mailing_address_postal
string
The contact's postal code.
title
string
The contact's job title.
url
string
A URL associated with the contact.
customfield1–10
string
Custom fields 1–10 available as part of the email campaign contact list.
status
string
The contact's status. Possible values:
Active, Inactive.subscriber_status
string
A combination of status log response status and send status. Possible values:
Unsent, Sent, Bounced, Unsubscribed, Partial (link clicked and at least one page submitted), Complete (link clicked and response completed).date_last_sent
string
Timestamp of when the campaign email was last sent to this contact. Empty string if never sent.
Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/survey/123456/surveycampaign/100000/surveycontact?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"total_count": 2,
"page": 1,
"total_pages": 1,
"results_per_page": 50,
"data": [
{
"id": 100039753,
"email_address": "jon.doe@alchemer.com",
"first_name": "Jon",
"last_name": "Doe",
"organization": "",
"division": "",
"department": "",
"team": "",
"group": "",
"role": "",
"home_phone": "",
"fax_phone": "",
"business_phone": "",
"mobilephone": "",
"mailing_address": "",
"mailing_address2": "",
"mailing_address_city": "",
"mailing_address_state": "",
"mailing_address_country": "",
"mailing_address_postal": "",
"title": "Vice President",
"url": "",
"customfield1": "sales",
"customfield2": "",
"status": "Active",
"subscriber_status": "Unsent",
"date_last_sent": ""
}
]
}