Wired Plus API Documentation

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

GET GetContacts

Retrieves a list of contacts.

Input and output parameters

The input and output parameters for this method are:

*denotes required field.

Input Parameter Name Type/Info
withfulldata Expand additional data fields, provide boolean 1,0
email the email address of the contacts
first_name the first name of the contacts
last_name the last name of the contact
name the name of the contact
opt_in_type (status of the opt in of the user, set to 0 for not opted in, 1 is opted in)
status Filter by contact status: Active, Archived, Suppressed, Unsubscribed, DomainSuppression
select Number of items to return, maximum 500.
skip Number of records to skip
sort Sort results, create_date_asc | create_date_desc | update_date_asc | update_date_desc
Outputs:
  • id (unique identifier of contact, the id can be used to call another call getCustomFieldsForContact to list associated custom fields)
  • uid (additional unique identifier for contact, alpha-numerical)
  • email (the email address of the contact)
  • opt_in_type (status of the opt in of the user, set to 0 for not opted in, 1 is opted in)
  • email_type (the email type of the user)
  • status (the status of the contact)
  • first_name
  • last_name
  • name
  • gender
  • opt_in_date (the date the contact was opted in)
  • post_code

Examples

Curl

PHP

jQuery

Result Format JSON