Skip to content

QueryContactList

Search for contact handles, wildcards are allowed for every parameter. Default will show all contacts.

Possible Gateways

The following parameters are standard parameters for this command.

Command
COMMAND = QueryContactList
Response
code = (INT)
description = (TEXT)
property[CONTACT][n] = (CONTACT)
CONTACTID of the contact handle
COUNTTotal number of contacts shown
FIRSTPointer to the first shown ID
LASTPointer to the last shown ID
LIMITThe limit given in the command
TOTALTotal number of existing contacts

The following parameters are optional for this command.

Command
COMMAND = QueryContactList
CONTACT = (PATTERN)
TITLE = (PATTERN)
FIRSTNAME = (TEXT)
MIDDLENAME = (TEXT)
LASTNAME = (TEXT)
ORGANIZATION = (TEXT)
LAYER = DEFAULT|SHOWSUBLAYER|SHOWMERGEDLAYER
STREET = (TEXT)
ZIP = (PATTERN)
CITY = (TEXT)
STATE = (TEXT)
COUNTRY = (TEXT)
PHONE = (PATTERN)
FAX = (PATTERN)
EMAIL = (PATTERN)
VALIDATED = (PATTERN)
VERIFIED = (PATTERN)
WIDE = 0|1
GENERATELIST = 0|1
TYPE = DEFAULT|SHOWVERIFICATIONREQUESTED
SENDLISTEMAIL = (EMAILS)
ORDER = ASC|DESC
ORDERBY = ID|FIRSTNAME|LASTNAME|ORGANIZATION|STREET|CITY|ZIP|COUNTRY|EMAIL|VALIDATED|VERIFIED|CREATEDDATE
STATUS = LINKED|UNLINKED|CLIENTAUTODELETEPROHIBITED
FIRST = (INT)
LIMIT = (INT)
Response
code = (INT)
description = (TEXT)
property[CONTACT][n] = (CONTACT)
property[ROID][n] = (TEXT)
property[CONTACT_TITLE][n] = (TEXT)
property[CONTACT_FIRSTNAME][n] = (TEXT)
property[CONTACT_MIDDLENAME][n] = (TEXT)
property[CONTACT_LASTNAME][n] = (TEXT)
property[CONTACT_ORGANIZATION][n] = (TEXT)
property[CONTACT_STREET][n] = (TEXT)
property[CONTACT_CITY][n] = (TEXT)
property[CONTACT_STATE][n] = (TEXT)
property[CONTACT_ZIP][n] = (TEXT)
property[CONTACT_COUNTRY][n] = (COUNTRY)
property[CONTACT_PHONE][n] = (PHONE)
property[CONTACT_FAX][n] = (PHONE)
property[CONTACT_EMAIL][n] = (EMAIL)
property[CREATED_DATE][n] = (DATE)
property[CREATED_BY][n] = (TEXT)
property[UPDATED_DATE][n] = (DATE)
property[UPDATED_BY][n] = (TEXT)
property[VALIDATED][n] = (TEXT)
property[VERIFIED][n] = (TEXT)
property[VERIFICATION_LAST_REQUESTED][n] = (TEXT)
property[VERIFICATION_CREATED_DATE][n] = (DATE)
property[VERIFICATION_HISTORY][n] = (TEXT)
property[REGISTRAR][n] = (TEXT)
property[STATUS][n] = (TEXT)
property[DELETION DATE][n] = (DATE)
property[COUNT][0] = (INT)
property[FIRST][0] = (INT)
property[LAST][0] = (INT)
property[LIMIT][0] = (INT)
property[TOTAL][0] = (INT)
CONTACTSearch for contacts with this ID (optional)
ROIDRegistry Object ID, unique ID of this contact
CONTACT_TITLETitle given in the contact
CONTACT_FIRSTNAMEFirst name given in the contact
CONTACT_MIDDLENAMESecond name given in the contact
CONTACT_LASTNAMELast name given in the contact
CONTACT_ORGANIZATIONOrganization given in the contact
CONTACT_STREETStreet given in the contact
CONTACT_CITYCity given in the contact
CONTACT_STATEState given in the contact
CONTACT_ZIPZip code given in the contact
CONTACT_COUNTRYCountry given in the contact
CONTACT_PHONEPhone number given in the contact
CONTACT_FAXFAX number given in the contact
CONTACT_EMAILEmail given in the contact
CREATED_DATEDate the contact handle was created
CREATED_BYAccount the contact handle was created in
UPDATED_DATEDate of the last modification of the contact handle
UPDATED_BYAccount who did the last modification of the contact handle
VALIDATEDValidated given in the contact
VERIFIEDVerified given in the contact
VERIFICATION_LAST_REQUESTEDLast email verification requested date
VERIFICATION_CREATED_DATEVerification created date
VERIFICATION_HISTORYChronological history of verification requests
REGISTRARReseller
TITLESearch for contacts with this title (optional)
FIRSTNAMESearch for contacts with this first name (optional)
MIDDLENAMESearch for contacts with this middle (second) name (optional)
LASTNAMESearch for contacts with this last name (optional)
ORGANIZATIONSearch for contacts with this organization (optional)
LAYERThe default contactlist | Show all contacts located on suberseller accounts | Show all contacts including own and all subreseller contacts | Show all suspended domains|Show all domains with unverified owner contacts | Select the dataset based on different criterias (optional)
STREETSearch for contacts with this street (optional)
ZIPSearch for contacts with this zip code (optional)
CITYSearch for contacts with this city (optional)
STATESearch for contacts with this state (optional)
STATUSLINKED|UNLINKED|CLIENTAUTODELETEPROHIBITED
DELETION DATEYYYY-MM-DD
COUNTRYSearch for contacts with this country (optional)
PHONESearch for contacts with this phone number (optional)
FAXSearch for contacts with this FAX number (optional)
EMAILSearch for contacts with this email (optional)
VALIDATEDSearch for contacts with validated contact data (optional)
VERIFIEDSearch for contacts with verified email address (optional)
WIDE0|1 (optional)
GENERATELISTShow result on screen|Generate a CSV File and upload to ftp or send by email (optional)
TYPESelect the dataset based on different criterias (optional)
SENDLISTEMAILEmail address where the CSV will be sent to (optional)
ORDERASC|DESC (optional)
ORDERBYOrder the results for the corresponding column. Default is ID. (optional)
FIRSTStart the output of results from this item (optional)
LIMITShow only this many items in the response (optional)