Get a customer by key

Gets a Customer by Key. Returns null if the Customer doesn't exist.

Request
query Parameters
key
required
string <guid>

The Key of the Customer to fetch.

cultureCode
string

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompanies
string

Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Responses
200

Success

500

Internal Server Error

get/CustomerService.svc/rest/GetCustomerByKey
Response samples
{
  • "Id": 0,
  • "Key": "string",
  • "Code": "string",
  • "Email": "string",
  • "SSN": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "Phone": "string",
  • "CellPhone": "string",
  • "ReferId": 0,
  • "ReferUrl": "string",
  • "Account": {
    },
  • "Companies": [
    ],
  • "DeliveryAddresses": [
    ],
  • "InvoiceAddress": {
    },
  • "Flags": [
    ],
  • "UseInvoiceAddressAsDeliveryAddress": true,
  • "Info": [
    ],
  • "PricelistIds": [
    ],
  • "CrmId": "string",
  • "IsActive": true,
  • "Created": "2019-08-24T14:15:22Z",
  • "Updated": "2019-08-24T14:15:22Z"
}