Skip to content

getSites

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to GET /v1/sites in the new API; the migration guide has the recommended order of work and the important model differences.

Legacy supported a startDate/endDate "modified-since" filter (returning sites changed in the period including contact/attribute changes). The new endpoint filters by siteRef/clientId only - there is no equivalent date-range/changed-since filter.

Open GET /v1/sites in the new API →

View legacy reference

/rest/contact/getSites/{clientId}/{startDate}/{endDate}/

GET
Gets sites details for the client ref specified that have been modified or added (this includes modification to sites, site contacts, contacts or site attributes) within the period specified by the startDate and endDate parameters.  Site details include the site contacts and site attributes.

Parameters

clientId - the ID of the client
startDate - OPTIONAL start date/time to use when determining period within which sites have been added/modified - in format dd-mmm-yyyy hh:mm:ss
endDate - OPTIONAL end date/time to use when determining period within which sites have been added/modified - in format dd-mmm-yyyy hh:mm:ss

e.g. rest/contact/getSites/171

available response representations:
  • 200 - XML

<root>  <sites>    <site>      <clientRef>12</clientRef>      <siteRef>abc123</siteRef>      <siteType>House</siteType>      <siteGroup>Default</siteGroup>      <usageType>Default</usageType>      <region>North</region>      <name>12 Susan Street</name>      <address1>12 Susan Street</address1>   <address2>Susanville</address2>   <address3>Susanshire</address3>   <address4></address4>   <postCode>SU3 4SU</postCode>   <status>Live</status>   <area>S</area>   <considerations>beware of susan</considerations>
   <contacts>     <contact>       <ref>abc223</ref>       <salutation>Mr</salutation>       <forename>Susan</forename>       <surname>Susnaovich</surname>       <contact1>01323 667 8869<contact1>       <contact1type>Home Phone</contact1Type>       <contact2>susan@susan.com</contact2>       <contact2Type>Email</contact2Type>       <contact3></contact3>       <contact3Type></contact3Type>       <contact4></contact4>       <contact4Type></contact4Type>       <preferredContact>1</preferredContact>       <notes>susan has noted</notes>       <considerations>beware of susans</considerations>       <preferred>1<preferred>       <startDate>12/12/1987</startDate>       <endDate>23/03/2032</endDate>     </contact>   </contacts>
   <attributes>     <attribute>       <name>Colour</name>       <value>Red</value>     </attribute>   </attributes>
 </site>
  </sites></root>





See the Contact API matrix for the full list of endpoints in this category.