GET api/v1/clients/{clientUid}

Gets the client by the specified client UID.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientUid	The client UID.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns the client by the company and client UID.

ClientViewModel

Name	Description	Type	Additional information
AddressLine1	The address line1.	string	None.
AddressLine2	The address line2.	string	None.
AddressLine3	The address line3.	string	None.
AddressLine4	The address line4.	string	None.
Name	The client name.	string	None.
PostCode	The post code.	string	None.
Country	The country.	CountryViewModel	None.
Company	The company.	CompanyViewModel	None.
ReferenceNumber	Client Reference Number.	string	None.
TimesheetNotificationAddress	The default email address to sent timesheet notifications	string	None.
ClientGuid	The client unnique 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:

{
  "AddressLine1": "sample string 1",
  "AddressLine2": "sample string 2",
  "AddressLine3": "sample string 3",
  "AddressLine4": "sample string 4",
  "Name": "sample string 5",
  "PostCode": "sample string 6",
  "Country": {
    "Iso3Code": "sample string 1",
    "Name": "sample string 2",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "7252e9cd-b120-4559-aba9-23f5358a4c6f",
      "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:24.7121973+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "c5d04b3a-91fe-4744-ba51-2c3fde06f1c9",
    "Uid": "eb98f250-a84c-42df-bbab-36ee59c75ee7",
    "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:24.7121973+00:00",
    "UpdatedBy": "sample string 5"
  },
  "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": "7252e9cd-b120-4559-aba9-23f5358a4c6f",
        "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:24.7121973+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "c5d04b3a-91fe-4744-ba51-2c3fde06f1c9",
      "Uid": "eb98f250-a84c-42df-bbab-36ee59c75ee7",
      "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:24.7121973+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "a6ade2e0-0c36-42f3-a148-fc0078718f0e",
    "PortalGuid": "09d0e587-d303-4ae9-8253-c632fb4a5e65",
    "CompanyGuid": "1547fb37-e317-4480-82a3-21d4efe09d24",
    "Uid": "2b10e396-c407-4680-9091-8d73ffaecc4f",
    "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:24.7121973+00:00",
    "UpdatedBy": "sample string 13"
  },
  "ReferenceNumber": "sample string 7",
  "TimesheetNotificationAddress": "sample string 8",
  "ClientGuid": "8422bd01-0235-43e4-ae60-ff960aea2d75",
  "Uid": "d96bfa09-be35-404d-8905-d8bcc6900f8d",
  "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:24.7121973+00:00",
  "UpdatedBy": "sample string 11"
}

application/xml, text/xml

Sample:

<ClientViewModel 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:24.7121973+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>d96bfa09-be35-404d-8905-d8bcc6900f8d</Uid>
  <UpdatedBy>sample string 11</UpdatedBy>
  <AddressLine1>sample string 1</AddressLine1>
  <AddressLine2>sample string 2</AddressLine2>
  <AddressLine3>sample string 3</AddressLine3>
  <AddressLine4>sample string 4</AddressLine4>
  <ClientGuid>8422bd01-0235-43e4-ae60-ff960aea2d75</ClientGuid>
  <Company>
    <DateUpdated>2025-10-27T13:57:24.7121973+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>2b10e396-c407-4680-9091-8d73ffaecc4f</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>1547fb37-e317-4480-82a3-21d4efe09d24</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T13:57:24.7121973+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>eb98f250-a84c-42df-bbab-36ee59c75ee7</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>c5d04b3a-91fe-4744-ba51-2c3fde06f1c9</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:57:24.7121973+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>7252e9cd-b120-4559-aba9-23f5358a4c6f</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>09d0e587-d303-4ae9-8253-c632fb4a5e65</PortalGuid>
    <PortalUid>a6ade2e0-0c36-42f3-a148-fc0078718f0e</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>
    <DateUpdated>2025-10-27T13:57:24.7121973+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>eb98f250-a84c-42df-bbab-36ee59c75ee7</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>c5d04b3a-91fe-4744-ba51-2c3fde06f1c9</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-10-27T13:57:24.7121973+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>7252e9cd-b120-4559-aba9-23f5358a4c6f</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
  </Country>
  <Name>sample string 5</Name>
  <PostCode>sample string 6</PostCode>
  <ReferenceNumber>sample string 7</ReferenceNumber>
  <TimesheetNotificationAddress>sample string 8</TimesheetNotificationAddress>
</ClientViewModel>