GET api/v1/clients/sites/{clientSiteUid}
Gets the client site by the specified client site UID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientSiteUid |
The client site UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the client site model.
ClientSiteViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The client sitename. |
string |
None. |
| AddressLine1 |
The client site address line 1. |
string |
None. |
| AddressLine2 |
The client site address line 2. |
string |
None. |
| AddressLine3 |
The client site address line 3. |
string |
None. |
| AddressLine4 |
The client site address line 4. |
string |
None. |
| PostCode |
The client site postcode. |
string |
None. |
| Country |
The client site country. |
string |
None. |
| Telephone |
The client site telephone number. |
string |
None. |
| Fax |
The client site fax number. |
string |
None. |
|
The client site email address. |
string |
None. |
|
| Client |
The client. |
ClientViewModel |
None. |
| ClientSiteGuid |
The unique guid for the client site |
globally unique identifier |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": "sample string 7",
"Telephone": "sample string 8",
"Fax": "sample string 9",
"Email": "sample string 10",
"Client": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"AddressLine3": "sample string 3",
"AddressLine4": "sample string 4",
"Name": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "08d62d86-5682-4bdb-bbfa-6ce748e6cbd7",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "b603aa92-d4ba-4723-9402-6162719da600",
"Uid": "cb29621f-edbc-4a9f-a155-3c34a483098c",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 5"
},
"Company": {
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "08d62d86-5682-4bdb-bbfa-6ce748e6cbd7",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "b603aa92-d4ba-4723-9402-6162719da600",
"Uid": "cb29621f-edbc-4a9f-a155-3c34a483098c",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "bcf25918-8a93-4c0f-a509-6f9e7fff89ba",
"PortalGuid": "7167aa88-cbb7-4aa8-be57-a0c9160fbcca",
"CompanyGuid": "f9962ba4-cdbf-4384-8cf9-a53b7a081dac",
"Uid": "9436812c-f1f2-4b94-85cd-a8355cc0a81a",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 13"
},
"ReferenceNumber": "sample string 7",
"TimesheetNotificationAddress": "sample string 8",
"ClientGuid": "948d86b9-83da-4ef0-9508-099519d42fcc",
"Uid": "6a3bd33a-5608-46c6-934b-9d39ec6e1e6b",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 11"
},
"ClientSiteGuid": "55a3ae1b-24c8-4d50-9705-a0adce7ffe68",
"Uid": "ad7127e0-a1cc-4ca3-98f3-533f0d9ea5f6",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-12-21T17:53:36.0965781+00:00",
"UpdatedBy": "sample string 13"
}
application/xml, text/xml
Sample:
<ClientSiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>ad7127e0-a1cc-4ca3-98f3-533f0d9ea5f6</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<Client>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>6a3bd33a-5608-46c6-934b-9d39ec6e1e6b</Uid>
<UpdatedBy>sample string 11</UpdatedBy>
<AddressLine1>sample string 1</AddressLine1>
<AddressLine2>sample string 2</AddressLine2>
<AddressLine3>sample string 3</AddressLine3>
<AddressLine4>sample string 4</AddressLine4>
<ClientGuid>948d86b9-83da-4ef0-9508-099519d42fcc</ClientGuid>
<Company>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
</Links>
<Uid>9436812c-f1f2-4b94-85cd-a8355cc0a81a</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<CompanyGuid>f9962ba4-cdbf-4384-8cf9-a53b7a081dac</CompanyGuid>
<Country>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
</Links>
<Uid>cb29621f-edbc-4a9f-a155-3c34a483098c</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>b603aa92-d4ba-4723-9402-6162719da600</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
<d6p1:Link>
<d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
<d6p1:Method>sample string 2</d6p1:Method>
<d6p1:Rel>sample string 3</d6p1:Rel>
<d6p1:Title>sample string 4</d6p1:Title>
<d6p1:Type>sample string 5</d6p1:Type>
</d6p1:Link>
</Links>
<Uid>08d62d86-5682-4bdb-bbfa-6ce748e6cbd7</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
<Name>sample string 1</Name>
<PortalGuid>7167aa88-cbb7-4aa8-be57-a0c9160fbcca</PortalGuid>
<PortalUid>bcf25918-8a93-4c0f-a509-6f9e7fff89ba</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Country>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
</Links>
<Uid>cb29621f-edbc-4a9f-a155-3c34a483098c</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>b603aa92-d4ba-4723-9402-6162719da600</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-12-21T17:53:36.0965781+00:00</DateUpdated>
<Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
<d5p1:Link>
<d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
<d5p1:Method>sample string 2</d5p1:Method>
<d5p1:Rel>sample string 3</d5p1:Rel>
<d5p1:Title>sample string 4</d5p1:Title>
<d5p1:Type>sample string 5</d5p1:Type>
</d5p1:Link>
</Links>
<Uid>08d62d86-5682-4bdb-bbfa-6ce748e6cbd7</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Name>sample string 5</Name>
<PostCode>sample string 6</PostCode>
<ReferenceNumber>sample string 7</ReferenceNumber>
<TimesheetNotificationAddress>sample string 8</TimesheetNotificationAddress>
</Client>
<ClientSiteGuid>55a3ae1b-24c8-4d50-9705-a0adce7ffe68</ClientSiteGuid>
<Country>sample string 7</Country>
<Email>sample string 10</Email>
<Fax>sample string 9</Fax>
<Name>sample string 1</Name>
<PostCode>sample string 6</PostCode>
<Telephone>sample string 8</Telephone>
</ClientSiteViewModel>