GET api/v1/companies/{companyUid}

Gets the company by the specified company UID.

Request Information

URI Parameters

Name	Description	Type	Additional information
companyUid	The company UID.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns the company by the specified portal and company UID.

CompanyViewModel

Name	Description	Type	Additional information
Name	The company name.	string	None.
AddressLine1	The address line1.	string	None.
AddressLine2	The address line2.	string	None.
AddressLine3	The address line3.	string	None.
AddressLine4	The address line4.	string	None.
PostCode	The post code.	string	None.
Country	The country.	CountryViewModel	None.
Latitude	The latitude.	string	None.
Longitude	The longitude.	string	None.
PortalUid	The portal uid that this company belongs	globally unique identifier	None.
PortalGuid	The portal guid that this company belongs	globally unique identifier	None.
CompanyGuid	The company guid	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": {
    "Iso3Code": "sample string 1",
    "Name": "sample string 2",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "68bae59b-ebfa-410b-9e00-43951188c9dd",
      "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:55:58.1557502+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "de3f21a4-71cc-4f20-886c-a522454960f6",
    "Uid": "aaeaae7f-aa99-4ece-9e32-8263750eaea7",
    "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:55:58.1557502+00:00",
    "UpdatedBy": "sample string 5"
  },
  "Latitude": "sample string 7",
  "Longitude": "sample string 8",
  "PortalUid": "7226ed3c-8043-4fcc-a1d4-e30d0afb87c2",
  "PortalGuid": "db560321-1189-4ab4-aec6-8114f8d25c1e",
  "CompanyGuid": "8885b608-5a92-47cc-83bc-13d7e0392f67",
  "Uid": "503da17f-0c4b-4a63-9246-9b38b4ce6f4b",
  "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:55:58.1557502+00:00",
  "UpdatedBy": "sample string 13"
}

application/xml, text/xml

Sample:

<CompanyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:55:58.1557502+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>503da17f-0c4b-4a63-9246-9b38b4ce6f4b</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>8885b608-5a92-47cc-83bc-13d7e0392f67</CompanyGuid>
  <Country>
    <DateUpdated>2025-10-27T13:55:58.1557502+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>aaeaae7f-aa99-4ece-9e32-8263750eaea7</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>de3f21a4-71cc-4f20-886c-a522454960f6</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-10-27T13:55:58.1557502+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>68bae59b-ebfa-410b-9e00-43951188c9dd</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>db560321-1189-4ab4-aec6-8114f8d25c1e</PortalGuid>
  <PortalUid>7226ed3c-8043-4fcc-a1d4-e30d0afb87c2</PortalUid>
  <PostCode>sample string 6</PostCode>
</CompanyViewModel>