Contacts

Description

The Contacts call retrieves a list of contacts within the specified view and company the user has access to.

Parameters

• View – The numeric primary ID key of the view required (See Views)
• Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
• Client-Code – The organization primary key to return all the contacts for 1 organization
• Internal-Ref – The contact primary key to return just 1 record
• Search –String to use to search for records. This is a compound & fuzzy (phonetic) search.

Return Values

Response – XML or JSON containing the list of contacts.

The structure of the response is:

<Contacts TotalRows=nnn TotalPages=nnn MorePages=True/False>
  <Contact uuid={`{UUID of record}`}>
    <Internal-Ref> Numeric Primary key
    <Client-Code> Alpha foreign key to Organizations table e.g. 1/P9887 or 1/ACME
    <Title> Title (Mr/Mrs etc)
    <Firstname> First name
    <MiddleInitials> Middle initials
    <Name> Last name
    <ForwardsFullName> Full name (First, Init, Last)
    <BackwardsFullName> Full name (Last, First, Init)
    <Job-Title> Job Title
    <Salutation> Salutation
    <Add1> Contact organization name
    <Add2> Address line 1
    <Add3> Address line 2
    <Add4> Town
    <Add5> County
    <Add6> Postcode
    <Add7> Country
    <CellPhone> Mobile phone number
    <Direct-Telephone> DDI phone number
    <OtherPhone> Home phone number
    <Secondary Phone> Secondary phone number
    <Phone-Display> First populated phone no in order of priority
    <Fax> Fax number
    <Email> Email address
    <Inactive> True/False
    <Interests> Notes
    <Custom Fields>
      <Custom Label 1> Actual Field Label will be an attribute
      <Custom Label 2> ...