GET api/v1/portals/{portalUid}/companies/sites
Gets the sites by portal.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
The portal UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns all the site for the specified portal.
Collection of CompanySiteViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Portal |
The portal. |
PortalViewModel |
None. |
| Company |
The company. |
CompanyViewModel |
None. |
| Name |
The name. |
string |
None. |
| Address1 |
The address1. |
string |
None. |
| Address2 |
The address2. |
string |
None. |
| Address3 |
The address3. |
string |
None. |
| Address4 |
The address4. |
string |
None. |
| Postcode |
The post code. |
string |
None. |
| Country |
The country. |
string |
None. |
| Telephone |
The telephone. |
string |
None. |
| Fax |
The fax. |
string |
None. |
|
The email. |
string |
None. |
|
| Latitude |
The latitude. |
string |
None. |
| Longitude |
The longitude. |
string |
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:
[
{
"Portal": {
"Name": "sample string 1",
"Uid": "01407a2c-8c22-4a84-88b3-e06ea5e646a1",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 3"
},
"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": "01407a2c-8c22-4a84-88b3-e06ea5e646a1",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "f75e0a26-2d0f-4af1-9b8c-8ea2dda9e4ca",
"Uid": "f56b0aee-ca4b-466a-921d-046322315abe",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "9bfe66ee-ef9b-4544-8aef-18fa450124f4",
"PortalGuid": "333c2b83-811b-47cc-a592-eedb6bd67fe8",
"CompanyGuid": "8b914dd0-c637-4175-a9cd-812bf8de9628",
"Uid": "b8779a48-7165-4c02-9c39-58f3c27acfad",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 13"
},
"Name": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"Address4": "sample string 5",
"Postcode": "sample string 6",
"Country": "sample string 7",
"Telephone": "sample string 8",
"Fax": "sample string 9",
"Email": "sample string 10",
"Latitude": "sample string 11",
"Longitude": "sample string 12",
"Uid": "10fabee5-7ad4-4d47-af58-03997309d9c2",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 14"
},
{
"Portal": {
"Name": "sample string 1",
"Uid": "01407a2c-8c22-4a84-88b3-e06ea5e646a1",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 3"
},
"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": "01407a2c-8c22-4a84-88b3-e06ea5e646a1",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "f75e0a26-2d0f-4af1-9b8c-8ea2dda9e4ca",
"Uid": "f56b0aee-ca4b-466a-921d-046322315abe",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "9bfe66ee-ef9b-4544-8aef-18fa450124f4",
"PortalGuid": "333c2b83-811b-47cc-a592-eedb6bd67fe8",
"CompanyGuid": "8b914dd0-c637-4175-a9cd-812bf8de9628",
"Uid": "b8779a48-7165-4c02-9c39-58f3c27acfad",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 13"
},
"Name": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"Address4": "sample string 5",
"Postcode": "sample string 6",
"Country": "sample string 7",
"Telephone": "sample string 8",
"Fax": "sample string 9",
"Email": "sample string 10",
"Latitude": "sample string 11",
"Longitude": "sample string 12",
"Uid": "10fabee5-7ad4-4d47-af58-03997309d9c2",
"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-10-27T13:59:43.3910092+00:00",
"UpdatedBy": "sample string 14"
}
]
application/xml, text/xml
Sample:
<ArrayOfCompanySiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<CompanySiteViewModel>
<DateUpdated>2025-10-27T13:59:43.3910092+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>10fabee5-7ad4-4d47-af58-03997309d9c2</Uid>
<UpdatedBy>sample string 14</UpdatedBy>
<Address1>sample string 2</Address1>
<Address2>sample string 3</Address2>
<Address3>sample string 4</Address3>
<Address4>sample string 5</Address4>
<Company>
<DateUpdated>2025-10-27T13:59:43.3910092+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>b8779a48-7165-4c02-9c39-58f3c27acfad</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>8b914dd0-c637-4175-a9cd-812bf8de9628</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T13:59:43.3910092+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>f56b0aee-ca4b-466a-921d-046322315abe</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>f75e0a26-2d0f-4af1-9b8c-8ea2dda9e4ca</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T13:59:43.3910092+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>01407a2c-8c22-4a84-88b3-e06ea5e646a1</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>333c2b83-811b-47cc-a592-eedb6bd67fe8</PortalGuid>
<PortalUid>9bfe66ee-ef9b-4544-8aef-18fa450124f4</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Country>sample string 7</Country>
<Email>sample string 10</Email>
<Fax>sample string 9</Fax>
<Latitude>sample string 11</Latitude>
<Longitude>sample string 12</Longitude>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-10-27T13:59:43.3910092+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>01407a2c-8c22-4a84-88b3-e06ea5e646a1</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
<Postcode>sample string 6</Postcode>
<Telephone>sample string 8</Telephone>
</CompanySiteViewModel>
<CompanySiteViewModel>
<DateUpdated>2025-10-27T13:59:43.3910092+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>10fabee5-7ad4-4d47-af58-03997309d9c2</Uid>
<UpdatedBy>sample string 14</UpdatedBy>
<Address1>sample string 2</Address1>
<Address2>sample string 3</Address2>
<Address3>sample string 4</Address3>
<Address4>sample string 5</Address4>
<Company>
<DateUpdated>2025-10-27T13:59:43.3910092+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>b8779a48-7165-4c02-9c39-58f3c27acfad</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>8b914dd0-c637-4175-a9cd-812bf8de9628</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T13:59:43.3910092+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>f56b0aee-ca4b-466a-921d-046322315abe</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>f75e0a26-2d0f-4af1-9b8c-8ea2dda9e4ca</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T13:59:43.3910092+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>01407a2c-8c22-4a84-88b3-e06ea5e646a1</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>333c2b83-811b-47cc-a592-eedb6bd67fe8</PortalGuid>
<PortalUid>9bfe66ee-ef9b-4544-8aef-18fa450124f4</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<Country>sample string 7</Country>
<Email>sample string 10</Email>
<Fax>sample string 9</Fax>
<Latitude>sample string 11</Latitude>
<Longitude>sample string 12</Longitude>
<Name>sample string 1</Name>
<Portal>
<DateUpdated>2025-10-27T13:59:43.3910092+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>01407a2c-8c22-4a84-88b3-e06ea5e646a1</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
<Postcode>sample string 6</Postcode>
<Telephone>sample string 8</Telephone>
</CompanySiteViewModel>
</ArrayOfCompanySiteViewModel>