GET api/Customer/GetCustomer/{id}?identificationNumber={identificationNumber}&identificationNumberCustomTitle={identificationNumberCustomTitle}

Gets Customer's details.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	customer's Id	integer	None.
identificationNumber	customer's Identification Number	string	None.
identificationNumberCustomTitle	custom field Identification Number Title	string	Default value is IČ

Body Parameters

None.

Response Information

Resource Description

GetCustomerResult

Name	Description	Type	Additional information
Id	The customer id	integer	None.
Name	The customer's name	string	None.
Phones	The customer's phones	Collection of string	None.
Emails	The customer's emails	Collection of string	None.
Web	The customer's web	string	None.
Description	The customer's description	string	None.
Location	The customer's location	string	None.
StreetNo	The customer's street and number of descriptive	string	None.
PostalCode	The customer's postal code	string	None.
CountryCode	The customer's country code. The code is specified by three letters	string	None.
EmailDomains	The customer's email domains	Collection of string	None.
Disabled	If true the customer is disabled	boolean	None.
City	The customer's city	string	None.
TimeZoneId	The time zone identifier (TimeZoneInfo.Id Property)	string	None.
Users	All customer's users.	Collection of CustomerUserRow	None.
Attachments	All customer's attachments.	Collection of CustomerAttachmentRow	None.
Notes	All customer's notes.	Collection of CustomerNoteRow	None.
FieldData	Fields data	Collection of CustomerCustomFieldData	None.
CustomerGroups	All customer's groups.	Collection of CustomerGroupData	None.
Tags	All customer's tags.	Collection of TagData	None.
ExternalId	Id from another system to identificate user	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "Company Ltd.",
  "Phones": [
    "+420 123 456 789"
  ],
  "Emails": [
    "company@domain.com"
  ],
  "Web": "www.requestor.com",
  "Description": "Everything else",
  "Location": null,
  "StreetNo": "Street 25",
  "PostalCode": "111 11",
  "CountryCode": "CZE",
  "EmailDomains": [
    "requestor.com"
  ],
  "Disabled": false,
  "City": "Brno",
  "TimeZoneId": "Central Europe Standard Time",
  "Users": [
    {
      "UserProviderKey": "851f037d-fcb1-453e-b7ae-8a4ab5599344",
      "UserFullName": "John Doe",
      "CanAccessOthersTickets": true,
      "CanEditOthersTickets": true,
      "CanManageOthersTickets": false
    }
  ],
  "Attachments": null,
  "Notes": [
    {
      "Id": 1,
      "Text": "Everything else",
      "DateAddUtc": "2024-04-28T02:03:39.5280153Z",
      "SubmitterFullName": "John Doe"
    }
  ],
  "FieldData": null,
  "CustomerGroups": [
    {
      "Id": 1,
      "Name": "VIP",
      "Color": "#ffffff",
      "Description": "Our best customers"
    }
  ],
  "Tags": [
    {
      "Id": 1,
      "Name": "Sample tag",
      "Static": true,
      "Color": "#ffffff",
      "Type": 2
    },
    {
      "Id": 2,
      "Name": "Sample 2",
      "Static": true,
      "Color": "#fafafa",
      "Type": 2
    }
  ],
  "ExternalId": null
}

application/xml, text/xml

Sample:

<GetCustomerResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Attachments i:nil="true" />
  <City>Brno</City>
  <CountryCode>CZE</CountryCode>
  <CustomerGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
    <d2p1:CustomerGroupData>
      <d2p1:Color>#ffffff</d2p1:Color>
      <d2p1:Description>Our best customers</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>VIP</d2p1:Name>
    </d2p1:CustomerGroupData>
  </CustomerGroups>
  <Description>Everything else</Description>
  <Disabled>false</Disabled>
  <EmailDomains xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>requestor.com</d2p1:string>
  </EmailDomains>
  <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>company@domain.com</d2p1:string>
  </Emails>
  <ExternalId i:nil="true" />
  <FieldData xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" />
  <Id>1</Id>
  <Location i:nil="true" />
  <Name>Company Ltd.</Name>
  <Notes>
    <GetCustomerNotesResult.CustomerNoteRow>
      <DateAddUtc>2024-04-28T02:03:39.5280153Z</DateAddUtc>
      <Id>1</Id>
      <SubmitterFullName>John Doe</SubmitterFullName>
      <Text>Everything else</Text>
    </GetCustomerNotesResult.CustomerNoteRow>
  </Notes>
  <Phones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>+420 123 456 789</d2p1:string>
  </Phones>
  <PostalCode>111 11</PostalCode>
  <StreetNo>Street 25</StreetNo>
  <Tags xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
    <d2p1:TagData>
      <d2p1:Color>#ffffff</d2p1:Color>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>Sample tag</d2p1:Name>
      <d2p1:Static>true</d2p1:Static>
      <d2p1:Type>UserAndCompany</d2p1:Type>
    </d2p1:TagData>
    <d2p1:TagData>
      <d2p1:Color>#fafafa</d2p1:Color>
      <d2p1:Id>2</d2p1:Id>
      <d2p1:Name>Sample 2</d2p1:Name>
      <d2p1:Static>true</d2p1:Static>
      <d2p1:Type>UserAndCompany</d2p1:Type>
    </d2p1:TagData>
  </Tags>
  <TimeZoneId>Central Europe Standard Time</TimeZoneId>
  <Users>
    <GetCustomerUsersResult.CustomerUserRow>
      <CanAccessOthersTickets>true</CanAccessOthersTickets>
      <CanEditOthersTickets>true</CanEditOthersTickets>
      <CanManageOthersTickets>false</CanManageOthersTickets>
      <UserFullName>John Doe</UserFullName>
      <UserProviderKey>851f037d-fcb1-453e-b7ae-8a4ab5599344</UserProviderKey>
    </GetCustomerUsersResult.CustomerUserRow>
  </Users>
  <Web>www.requestor.com</Web>
</GetCustomerResult>