Wired Plus API Documentation

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

GET GetCampaignContacts

Retrieves contacts from a specific campaign.

Input and output parameters

The input and output parameters for this method are:

*denotes required field.

Input Parameter Name Type/Info
campaign_id* id of the campaign.
withfulldata values are 'true' or 'false', returns all data for a contact.
email Filter by the email address of the contact.
first_name Filter by the first name of the contact.
last_name Filter by the last name of the contact.
name Filter by the name of the contact.
opt_in_type status of the opt in of the contact, set to 0 for not opted in, 1 for opted in
status the status of the contact.
select integer (11), the number to return, max of 500.
skip integer (11), the number of contacts to skip.
sort How to sort the results, options: date_added_asc | date_added_desc | create_date_asc | create_date_desc | update_date_asc | update_date_desc
Outputs:
  • id, wthe id of the contact
  • create_date (date contact was created)
  • update_date (date contact was updated)
  • first_name
  • last_name
  • name
  • opt_in (status of the opt in of the user, set to 0 for not opted in, 1 is opted in)
  • opt_in_date (the date the contact was opted in)
  • status (the status of the contact)

Examples

Curl

PHP

jQuery

Result Format JSON