GET v1/Companies({CompanyId})/CustomerFull({CustomerId})

This call returns the Full Customer by id, including Addresses, Contact info, Extended Attributes, Documents, etc.

Information:

Base URL:

https://api.covasoft.net/crm

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	Company Id from your onboarding package	integer	Required
CustomerId	GUID for Customer from the GET customers Call	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns all the Customers in a Company

CustomerDetailsReturn

Name	Type	Additional information
Addresses	Collection of Address	None.
ContactMethods	Collection of ContactMethod	None.
CustomerExtensions	Collection of CustomerExtension	None.
RelatedCustomers	Collection of Object	None.
MemberOf	Collection of Object	None.
Documents	Collection of Object	None.
MergedCustomers	Collection of Object	None.
PrimaryName	string	None.
Title	string	None.
AlternateName	string	None.
MiddleName	string	None.
FamilyName	string	None.
ReferralSource	Object	None.
Notes	string	None.
UniqueIdentifier	string	None.
Id	globally unique identifier	None.
CustomerTypeId	integer	None.
CustomerType	string	None.
DateOfBirth	Object	None.
PricingGroupId	Object	None.
Disabled	boolean	None.
DoNotContact	boolean	None.
Version	integer	None.
MergedIntoCustomerId	Object	None.
LastModifiedDateUtc	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Addresses": [
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "388be3ff-d467-4815-806f-795ecc5896e1",
      "CustomerId": "394f2a23-adbb-4f1f-bfb5-4ac88a83c600",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "388be3ff-d467-4815-806f-795ecc5896e1",
      "CustomerId": "394f2a23-adbb-4f1f-bfb5-4ac88a83c600",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    }
  ],
  "ContactMethods": [
    {
      "Value": "sample string 1",
      "Id": "790617d3-aab1-469d-900a-ce40b9d22671",
      "CustomerId": "f5c6ebdc-3a19-46c3-b748-6cdf5c87d106",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    },
    {
      "Value": "sample string 1",
      "Id": "790617d3-aab1-469d-900a-ce40b9d22671",
      "CustomerId": "f5c6ebdc-3a19-46c3-b748-6cdf5c87d106",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    }
  ],
  "CustomerExtensions": [
    {
      "Value": "sample string 1",
      "Id": "17673732-df8c-4108-9703-239602f1848f",
      "CustomerId": "861fff20-47b9-4aa6-8073-dcbd3b13276b",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    },
    {
      "Value": "sample string 1",
      "Id": "17673732-df8c-4108-9703-239602f1848f",
      "CustomerId": "861fff20-47b9-4aa6-8073-dcbd3b13276b",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    }
  ],
  "RelatedCustomers": [
    {},
    {}
  ],
  "MemberOf": [
    {},
    {}
  ],
  "Documents": [
    {},
    {}
  ],
  "MergedCustomers": [
    {},
    {}
  ],
  "PrimaryName": "sample string 1",
  "Title": "sample string 2",
  "AlternateName": "sample string 3",
  "MiddleName": "sample string 4",
  "FamilyName": "sample string 5",
  "ReferralSource": {},
  "Notes": "sample string 7",
  "UniqueIdentifier": "sample string 8",
  "Id": "511bc98c-1b11-4819-b4f6-d45b8ff621d1",
  "CustomerTypeId": 10,
  "CustomerType": "sample string 11",
  "DateOfBirth": {},
  "PricingGroupId": {},
  "Disabled": true,
  "DoNotContact": true,
  "Version": 16,
  "MergedIntoCustomerId": {},
  "LastModifiedDateUtc": "2025-02-20T19:19:12.5766841+00:00"
}