Skip to content
  • There are no suggestions because the search field is empty.

CRM Contact

URL

Verbs

Function

/CRMContact

 GET

Query a list of CRM Contacts
/CRMContact POST Create a new CRM Contact

/CRMContact/<code>

GET

Query a single CRM Contact
/CRMContact/<code> POST Update an existing CRM Contact

 

Supported modifiers

Query String

Definition
Sample

Released
emailFilter Query CRM Contacts with an email address emailFilter=bob@domain.com  
organisation Query CRM Contacts for a particular CRM Organisaction organisation=1045  
modifiedSince Return CRM Contacts modified since a nominated date and time modifiedSince=2013-02-28T16:45:00  
treeName and treeBranch Return a list of CRM Contacts assigned to a nominated branch of a nominated tree treeName=Colour-AUS&treeBranch=Blue  
status Return a list of CRM Contacts with a nominated status status=Active  
nameFilter Return a list of CRM Contacts with the requested name nameFilter=Mary Smith 2020.1
includeCrossReferences Include the Cross References Organisations and Contacts includeCrossReferences=true 2021.2
phoneFilter Return a list of CRM Contacts with the requested Phone number (phone, phoneAH and mobile) phoneFilter=03482223 2021.3

Security Linked Menu

Menu Item
Located
Contacts CRM / Relationships

Sample XML Response

<?xml version="1.0" encoding="UTF-8"?>
<CRMContact>
    <Code>10000</Code>
    <Edition>93</Edition>
    <OidString>5509.1</OidString>
    <Alpha>Stanley</Alpha>
    <CasualName>Lisa</CasualName>
    <DateOfBirth>1960-05-12</DateOfBirth>
    <EntryTimeStamp>2004-01-03T10:38:21</EntryTimeStamp>
    <EntryUser>SUPER</EntryUser>
    <FormalName>Dr Stanley</FormalName>
    <FormalTitle>Dr</FormalTitle>
    <Gender>F</Gender>
    <Interests>Arts,Sport,Dice</Interests>
    <IsReseller>false</IsReseller>
    <IsVerified>false</IsVerified>
    <ModifiedTimeStamp>2013-12-14T16:36:50</ModifiedTimeStamp>
    <ModifiedUser>SUPER</ModifiedUser>
    <IsBusPostalPerOrg>true</IsBusPostalPerOrg>
    <IsBusPostalPerStreet>true</IsBusPostalPerStreet>
    <IsBusStreetPerOrg>true</IsBusStreetPerOrg>
    <IsExcludeCallRoster>true</IsExcludeCallRoster>
    <IsExcludeMailList>true</IsExcludeMailList>
    <IsFaxPerContact>false</IsFaxPerContact>
    <IsMySalesPersonFromOrg>false</IsMySalesPersonFromOrg>
    <IsPhoneNumberPerContact>false</IsPhoneNumberPerContact>
    <IsPrimaryContact>false</IsPrimaryContact>
    <IsDebtCollectionContact>false</IsDebtCollectionContact>
    <IsPersPostalPerOrg>true</IsPersPostalPerOrg>
    <IsPersPostalPerStreet>true</IsPersPostalPerStreet>
    <IsPersStreetPerOrg>true</IsPersStreetPerOrg>
    <AssignedTeam>Sales Team</AssignedTeam>
    <AssignedUser>SUPER</AssignedUser>
    <Organisation>1000</Organisation>
    <SalesPerson>SAMPSS</SalesPerson>
    <Relationship>Other</Relationship>
    <Status>Active</Status>
    <Name>Lisa Stanley</Name>
    <Notes/>
    <Occupation/>
    <Pager/>
    <Salutation/>
    <SalutationFormat>Formal</SalutationFormat>
    <SalutationString>Dr Stanley</SalutationString>
    <Title>Jr Vice President</Title>
    <ContactDetails>
        <Contact>Lisa Stanley</Contact>
        <Address1>50 Glengarry Ave</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Burwood</Suburb>
        <Postcode>3125</Postcode>
        <State>VIC</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(03) 8425 1213</PhoneBH>
        <PhoneAH/>
        <Fax>(03) 8425 1255</Fax>
        <Email/>
        <Web/>
        <Mobile>0413 225 336</Mobile>
    </ContactDetails>
    <BusinessPostalAddress>
        <Contact>Lisa Stanley</Contact>
        <Address1>51 Glengarry Ave</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Burwood</Suburb>
        <Postcode>3125</Postcode>
        <State>VIC</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(03) 8425 1213</PhoneBH>
        <PhoneAH/>
        <Fax>(03) 8425 1255</Fax>
        <Email/>
        <Web/>
        <Mobile>0413 225 336</Mobile>
    </BusinessPostalAddress>
    <BusinessStreetAddress>
        <Contact>Lisa Stanley</Contact>
        <Address1>51 Glengarry Ave</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Burwood</Suburb>
        <Postcode>3125</Postcode>
        <State>VIC</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(03) 8425 1213</PhoneBH>
        <PhoneAH/>
        <Fax>(03) 8425 1255</Fax>
        <Email/>
        <Web/>
        <Mobile>0413 225 336</Mobile>
    </BusinessStreetAddress>
    <PersonalPostalAddress>
        <Contact>Lisa Stanley</Contact>
        <Address1>51 Glengarry Ave</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Burwood</Suburb>
        <Postcode>3125</Postcode>
        <State>VIC</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(03) 8425 1213</PhoneBH>
        <PhoneAH/>
        <Fax>(03) 8425 1255</Fax>
        <Email/>
        <Web/>
        <Mobile>0413 225 336</Mobile>
    </PersonalPostalAddress>
    <PersonalStreetAddress>
        <Contact>Lisa Stanley</Contact>
        <Address1>51 Glengarry Ave</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Burwood</Suburb>
        <Postcode>3125</Postcode>
        <State>VIC</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(03) 8425 1213</PhoneBH>
        <PhoneAH/>
        <Fax>(03) 8425 1255</Fax>
        <Email/>
        <Web/>
        <Mobile>0413 225 336</Mobile>
    </PersonalStreetAddress>
    <UserDefinedFields collection='true' count='0'/>
    <Trees collection='true' count='1'>
        <Tree>
            <Name>Member of Board-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value>1-President</Value>
            <Path>1-President</Path>
            <ShortCode>PRESIDENT</ShortCode>
        </Tree>
    </Trees>
</CRMContact>