GET api/v1/agents/contacts/{agentContactUid}

Gets the agent contact by the specified Agent Contact UID.

Request Information

URI Parameters

Name	Description	Type	Additional information
agentContactUid	The agent contact UID.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns the agent contact.

AgentContactViewModel

Name	Description	Type	Additional information
Forename	The forename of the agent contact.	string	None.
Surname	The surname of the agent contact.	string	None.
JobTitle	The job title of the agent contact.	string	None.
Telephone	The telehone number for the agent contact.	string	None.
Mobile	The mobile telephone number for the agent contact.	string	None.
Email	The email address for the agent contact.	string	None.
Agent	Gets or sets the agent.	AgentViewModel	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:

{
  "Forename": "sample string 1",
  "Surname": "sample string 2",
  "JobTitle": "sample string 3",
  "Telephone": "sample string 4",
  "Mobile": "sample string 5",
  "Email": "sample string 6",
  "Agent": {
    "Portal": {
      "Name": "sample string 1",
      "Uid": "8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c",
      "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:49.0833302+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": "8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c",
          "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:49.0833302+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "8a9fa78a-2ba7-4bb8-84d3-c4ef448b05b9",
        "Uid": "1093d755-5d11-4693-a042-f8234151a540",
        "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:49.0833302+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "e7fe0103-2862-4335-b65a-e5f46e3b4b19",
      "PortalGuid": "58b56f66-579c-453d-9fe2-e14ed50a3fac",
      "CompanyGuid": "9ddb6f44-5783-4bc2-99b8-42b362762ecc",
      "Uid": "967152e8-69fb-4bf0-998d-70fac776cd8f",
      "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:49.0833302+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": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c",
        "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:49.0833302+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "8a9fa78a-2ba7-4bb8-84d3-c4ef448b05b9",
      "Uid": "1093d755-5d11-4693-a042-f8234151a540",
      "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:49.0833302+00:00",
      "UpdatedBy": "sample string 5"
    },
    "AgencyKey": "sample string 7",
    "Uid": "fe1f9906-3c83-4069-a30a-12af97b7b5ae",
    "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:49.0833302+00:00",
    "UpdatedBy": "sample string 9"
  },
  "Uid": "9250db9f-8d14-4862-a3f3-7617e0101d3d",
  "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:49.0833302+00:00",
  "UpdatedBy": "sample string 8"
}

application/xml, text/xml

Sample:

<AgentContactViewModel 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:49.0833302+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>9250db9f-8d14-4862-a3f3-7617e0101d3d</Uid>
  <UpdatedBy>sample string 8</UpdatedBy>
  <Agent>
    <DateUpdated>2025-10-27T13:57:49.0833302+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>fe1f9906-3c83-4069-a30a-12af97b7b5ae</Uid>
    <UpdatedBy>sample string 9</UpdatedBy>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <Address4>sample string 5</Address4>
    <AgencyKey>sample string 7</AgencyKey>
    <Company>
      <DateUpdated>2025-10-27T13:57:49.0833302+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>967152e8-69fb-4bf0-998d-70fac776cd8f</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>9ddb6f44-5783-4bc2-99b8-42b362762ecc</CompanyGuid>
      <Country>
        <DateUpdated>2025-10-27T13:57:49.0833302+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>1093d755-5d11-4693-a042-f8234151a540</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>8a9fa78a-2ba7-4bb8-84d3-c4ef448b05b9</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-10-27T13:57:49.0833302+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>8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c</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>58b56f66-579c-453d-9fe2-e14ed50a3fac</PortalGuid>
      <PortalUid>e7fe0103-2862-4335-b65a-e5f46e3b4b19</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <Country>
      <DateUpdated>2025-10-27T13:57:49.0833302+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>1093d755-5d11-4693-a042-f8234151a540</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>8a9fa78a-2ba7-4bb8-84d3-c4ef448b05b9</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:57:49.0833302+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>8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Name>sample string 1</Name>
    <Portal>
      <DateUpdated>2025-10-27T13:57:49.0833302+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>8caf26ce-ffc6-4da1-9c65-cb5c26d96e0c</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
    <PostCode>sample string 6</PostCode>
  </Agent>
  <Email>sample string 6</Email>
  <Forename>sample string 1</Forename>
  <JobTitle>sample string 3</JobTitle>
  <Mobile>sample string 5</Mobile>
  <Surname>sample string 2</Surname>
  <Telephone>sample string 4</Telephone>
</AgentContactViewModel>