GET api/v1/consultants/{consultantUid}
Gets the consultant by specified consultant UID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| consultantUid |
The consultant UID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns the consultant by the specified company and consultant.
ConsultantViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
|
The email. |
string |
None. |
|
| Forename |
The forename. |
string |
None. |
| Surname |
The surname. |
string |
None. |
| JobTitle |
The job title. |
string |
None. |
| Mobile |
The mobile. |
string |
None. |
| OtherNames |
The other names. |
string |
None. |
| Telephone |
The telephone. |
string |
None. |
| Company |
The company. |
CompanyViewModel |
None. |
| ConsultantGuid |
The consultant unique identifier |
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:
{
"Email": "sample string 1",
"Forename": "sample string 2",
"Surname": "sample string 3",
"JobTitle": "sample string 4",
"Mobile": "sample string 5",
"OtherNames": "sample string 6",
"Telephone": "sample string 7",
"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": "af0fc54d-9051-42bb-86ec-e454a447144d",
"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:57:25.8840734+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "3fb3c05e-83d4-432b-aecb-9cd5b6031b8b",
"Uid": "9ef25d78-69c1-4a44-a0fe-92bc8078af2c",
"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:57:25.8840734+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "b2091f67-aa86-487a-acc4-351aaace6761",
"PortalGuid": "e0abd19d-e842-46ad-b818-04245c2841f4",
"CompanyGuid": "4a9f8fa1-cafb-4e46-a37f-e3f83aa958c3",
"Uid": "8f7d993a-4eba-4cc8-a446-9046aca1883f",
"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:57:25.8840734+00:00",
"UpdatedBy": "sample string 13"
},
"ConsultantGuid": "c969e3c5-ef71-4007-8fd7-5e8e3b017cef",
"Uid": "621685e9-bc10-44b0-8eff-55b8249704f0",
"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:57:25.8840734+00:00",
"UpdatedBy": "sample string 10"
}
application/xml, text/xml
Sample:
<ConsultantViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T13:57:25.8840734+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>621685e9-bc10-44b0-8eff-55b8249704f0</Uid>
<UpdatedBy>sample string 10</UpdatedBy>
<Company>
<DateUpdated>2025-10-27T13:57:25.8840734+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>8f7d993a-4eba-4cc8-a446-9046aca1883f</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>4a9f8fa1-cafb-4e46-a37f-e3f83aa958c3</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T13:57:25.8840734+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>9ef25d78-69c1-4a44-a0fe-92bc8078af2c</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>3fb3c05e-83d4-432b-aecb-9cd5b6031b8b</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T13:57:25.8840734+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>af0fc54d-9051-42bb-86ec-e454a447144d</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>e0abd19d-e842-46ad-b818-04245c2841f4</PortalGuid>
<PortalUid>b2091f67-aa86-487a-acc4-351aaace6761</PortalUid>
<PostCode>sample string 6</PostCode>
</Company>
<ConsultantGuid>c969e3c5-ef71-4007-8fd7-5e8e3b017cef</ConsultantGuid>
<Email>sample string 1</Email>
<Forename>sample string 2</Forename>
<JobTitle>sample string 4</JobTitle>
<Mobile>sample string 5</Mobile>
<OtherNames>sample string 6</OtherNames>
<Surname>sample string 3</Surname>
<Telephone>sample string 7</Telephone>
</ConsultantViewModel>