GET request/customer/{CustomerId}/site/{SiteId}/contacts
Display company's all site contacts
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId | integer |
Required |
|
| SiteId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ContactView| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactId | integer |
None. |
|
| ContactRoleId | integer |
None. |
|
| CustomerID | integer |
None. |
|
| DateOfBirth | date |
None. |
|
| DeletedReason | string |
None. |
|
| string |
String length: inclusive between 0 and 250 |
||
| FirstName | string |
String length: inclusive between 0 and 100 |
|
| GDPRConsent | boolean |
None. |
|
| IsDeleted | boolean |
None. |
|
| IsMainContact | boolean |
None. |
|
| IsPartner | boolean |
None. |
|
| IsPrimaryContact | boolean |
None. |
|
| IsSignDirectDebitContracts | boolean |
None. |
|
| IsSignEnerySupplyContracts | boolean |
None. |
|
| JobTitle | string |
String length: inclusive between 0 and 100 |
|
| LandLine | string |
String length: inclusive between 0 and 11 |
|
| LastName | string |
String length: inclusive between 0 and 100 |
|
| Mobile | string |
String length: inclusive between 0 and 11 |
|
| SiteId | integer |
None. |
|
| Title | string |
String length: inclusive between 0 and 10 |
Response Formats
application/json, text/json
Sample:
[
{
"customerID": 1,
"siteId": 2,
"contactId": 3,
"isDeleted": true,
"deletedReason": "sample string 5",
"title": "sample string 6",
"firstName": "sample string 7",
"lastName": "sample string 8",
"mobile": "sample string 9",
"landLine": "sample string 10",
"email": "sample string 11",
"jobTitle": "sample string 12",
"isMainContact": true,
"isSignEnerySupplyContracts": true,
"isSignDirectDebitContracts": true,
"dateOfBirth": "2025-11-05T12:22:34.5728922+00:00",
"isPartner": true,
"isPrimaryContact": true,
"gdprConsent": true,
"contactRoleId": 1
},
{
"customerID": 1,
"siteId": 2,
"contactId": 3,
"isDeleted": true,
"deletedReason": "sample string 5",
"title": "sample string 6",
"firstName": "sample string 7",
"lastName": "sample string 8",
"mobile": "sample string 9",
"landLine": "sample string 10",
"email": "sample string 11",
"jobTitle": "sample string 12",
"isMainContact": true,
"isSignEnerySupplyContracts": true,
"isSignDirectDebitContracts": true,
"dateOfBirth": "2025-11-05T12:22:34.5728922+00:00",
"isPartner": true,
"isPrimaryContact": true,
"gdprConsent": true,
"contactRoleId": 1
}
]
text/html
Sample:
[{"customerID":1,"siteId":2,"contactId":3,"isDeleted":true,"deletedReason":"sample string 5","title":"sample string 6","firstName":"sample string 7","lastName":"sample string 8","mobile":"sample string 9","landLine":"sample string 10","email":"sample string 11","jobTitle":"sample string 12","isMainContact":true,"isSignEnerySupplyContracts":true,"isSignDirectDebitContracts":true,"dateOfBirth":"2025-11-05T12:22:34.5728922+00:00","isPartner":true,"isPrimaryContact":true,"gdprConsent":true,"contactRoleId":1},{"customerID":1,"siteId":2,"contactId":3,"isDeleted":true,"deletedReason":"sample string 5","title":"sample string 6","firstName":"sample string 7","lastName":"sample string 8","mobile":"sample string 9","landLine":"sample string 10","email":"sample string 11","jobTitle":"sample string 12","isMainContact":true,"isSignEnerySupplyContracts":true,"isSignDirectDebitContracts":true,"dateOfBirth":"2025-11-05T12:22:34.5728922+00:00","isPartner":true,"isPrimaryContact":true,"gdprConsent":true,"contactRoleId":1}]
application/xml, text/xml
Sample:
<ArrayOfContactView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Default">
<ContactView>
<ContactId>0</ContactId>
<ContactRoleId>1</ContactRoleId>
<DateOfBirth>2025-11-05T12:22:34.5728922+00:00</DateOfBirth>
<Email>sample string 11</Email>
<FirstName>sample string 7</FirstName>
<GDPRConsent>true</GDPRConsent>
<IsMainContact>true</IsMainContact>
<IsPartner>true</IsPartner>
<IsPrimaryContact>true</IsPrimaryContact>
<IsSignDirectDebitContracts>true</IsSignDirectDebitContracts>
<IsSignEnerySupplyContracts>true</IsSignEnerySupplyContracts>
<JobTitle>sample string 12</JobTitle>
<LandLine>sample string 10</LandLine>
<LastName>sample string 8</LastName>
<Mobile>sample string 9</Mobile>
<Title>sample string 6</Title>
<ContactId>3</ContactId>
<CustomerID>1</CustomerID>
<DeletedReason>sample string 5</DeletedReason>
<IsDeleted>true</IsDeleted>
<SiteId>2</SiteId>
</ContactView>
<ContactView>
<ContactId>0</ContactId>
<ContactRoleId>1</ContactRoleId>
<DateOfBirth>2025-11-05T12:22:34.5728922+00:00</DateOfBirth>
<Email>sample string 11</Email>
<FirstName>sample string 7</FirstName>
<GDPRConsent>true</GDPRConsent>
<IsMainContact>true</IsMainContact>
<IsPartner>true</IsPartner>
<IsPrimaryContact>true</IsPrimaryContact>
<IsSignDirectDebitContracts>true</IsSignDirectDebitContracts>
<IsSignEnerySupplyContracts>true</IsSignEnerySupplyContracts>
<JobTitle>sample string 12</JobTitle>
<LandLine>sample string 10</LandLine>
<LastName>sample string 8</LastName>
<Mobile>sample string 9</Mobile>
<Title>sample string 6</Title>
<ContactId>3</ContactId>
<CustomerID>1</CustomerID>
<DeletedReason>sample string 5</DeletedReason>
<IsDeleted>true</IsDeleted>
<SiteId>2</SiteId>
</ContactView>
</ArrayOfContactView>