POST 17.0/app/contacts/list

Description

Gets a list of Contacts

URI Parameters

None.

ContactListFilters
Name Description Type Additional information
Types

Collection of integer

None.
Statuses

Collection of integer

None.
Sources

Collection of integer

None.
AssignedUsers

Collection of integer

None.
Branches

Collection of integer

None.

application/json, text/json
Sample: 
{
  "types": [
    1,
    2
  ],
  "statuses": [
    1,
    2
  ],
  "sources": [
    1,
    2
  ],
  "assignedUsers": [
    1,
    2
  ],
  "branches": [
    1,
    2
  ]
}

application/xml, text/xml
Sample: 
<ContactListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Types>
    <int>1</int>
    <int>2</int>
  </Types>
  <Statuses>
    <int>1</int>
    <int>2</int>
  </Statuses>
  <Sources>
    <int>1</int>
    <int>2</int>
  </Sources>
  <AssignedUsers>
    <int>1</int>
    <int>2</int>
  </AssignedUsers>
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
</ContactListFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ContactListItem
Name Description Type Additional information
ID

integer

None.
FirstNames

string

None.
LastName

string

None.
Type

IDDescriptionPair

None.
Status

IDDescriptionPair

None.
HomeTelephone

string

None.
WorkTelephone

string

None.
MobileTelephone

string

None.
AltTelephone

string

None.
TelephoneNumbers

string

None.
Email

string

None.
AddedDate

date

None.
LastContactedDate

date

None.
MarketingPreferences

MarketingPreferences

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "firstNames": "sample string 2",
    "lastName": "sample string 3",
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "homeTelephone": "sample string 4",
    "workTelephone": "sample string 5",
    "mobileTelephone": "sample string 6",
    "altTelephone": "sample string 7",
    "telephoneNumbers": "sample string 8",
    "email": "sample string 9",
    "addedDate": "2025-01-09T20:39",
    "lastContactedDate": "2025-01-09T20:39",
    "marketingPreferences": {
      "post": true,
      "email": true,
      "smsText": true,
      "telephone": true,
      "passDetailsToThirdParties": true,
      "passDetailsToIFA": true,
      "passDetailsToConveyancer": true
    }
  },
  {
    "id": 1,
    "firstNames": "sample string 2",
    "lastName": "sample string 3",
    "type": {
      "id": 1,
      "description": "sample string 2"
    },
    "status": {
      "id": 1,
      "description": "sample string 2"
    },
    "homeTelephone": "sample string 4",
    "workTelephone": "sample string 5",
    "mobileTelephone": "sample string 6",
    "altTelephone": "sample string 7",
    "telephoneNumbers": "sample string 8",
    "email": "sample string 9",
    "addedDate": "2025-01-09T20:39",
    "lastContactedDate": "2025-01-09T20:39",
    "marketingPreferences": {
      "post": true,
      "email": true,
      "smsText": true,
      "telephone": true,
      "passDetailsToThirdParties": true,
      "passDetailsToIFA": true,
      "passDetailsToConveyancer": true
    }
  }
]

application/xml, text/xml
Sample: 
<ArrayOfContactListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactListItem>
    <ID>1</ID>
    <FirstNames>sample string 2</FirstNames>
    <LastName>sample string 3</LastName>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <HomeTelephone>sample string 4</HomeTelephone>
    <WorkTelephone>sample string 5</WorkTelephone>
    <MobileTelephone>sample string 6</MobileTelephone>
    <AltTelephone>sample string 7</AltTelephone>
    <TelephoneNumbers>sample string 8</TelephoneNumbers>
    <Email>sample string 9</Email>
    <AddedDate>2025-01-09T20:39:44.5999628+00:00</AddedDate>
    <LastContactedDate>2025-01-09T20:39:44.5999628+00:00</LastContactedDate>
    <MarketingPreferences>
      <Post>true</Post>
      <Email>true</Email>
      <SmsText>true</SmsText>
      <Telephone>true</Telephone>
      <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
      <PassDetailsToIFA>true</PassDetailsToIFA>
      <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
    </MarketingPreferences>
  </ContactListItem>
  <ContactListItem>
    <ID>1</ID>
    <FirstNames>sample string 2</FirstNames>
    <LastName>sample string 3</LastName>
    <Type>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Type>
    <Status>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Status>
    <HomeTelephone>sample string 4</HomeTelephone>
    <WorkTelephone>sample string 5</WorkTelephone>
    <MobileTelephone>sample string 6</MobileTelephone>
    <AltTelephone>sample string 7</AltTelephone>
    <TelephoneNumbers>sample string 8</TelephoneNumbers>
    <Email>sample string 9</Email>
    <AddedDate>2025-01-09T20:39:44.5999628+00:00</AddedDate>
    <LastContactedDate>2025-01-09T20:39:44.5999628+00:00</LastContactedDate>
    <MarketingPreferences>
      <Post>true</Post>
      <Email>true</Email>
      <SmsText>true</SmsText>
      <Telephone>true</Telephone>
      <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
      <PassDetailsToIFA>true</PassDetailsToIFA>
      <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
    </MarketingPreferences>
  </ContactListItem>
</ArrayOfContactListItem>