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
CustomerDetailsReturnName | Description | 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": "671043e3-9c0d-4b94-9a0b-4eb2bcd34753", "CustomerId": "56264ff7-3371-4bc6-82e6-e21b92b00b63", "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": "671043e3-9c0d-4b94-9a0b-4eb2bcd34753", "CustomerId": "56264ff7-3371-4bc6-82e6-e21b92b00b63", "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": "f1453423-3be2-4b86-864e-e4fa18410852", "CustomerId": "3c4b5179-acf4-43f4-a451-fc2dadc8e748", "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": "f1453423-3be2-4b86-864e-e4fa18410852", "CustomerId": "3c4b5179-acf4-43f4-a451-fc2dadc8e748", "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": "40006fb1-ce5a-490e-befb-ff529aa0565b", "CustomerId": "e2fc62d5-6646-4b70-8924-7b1f8eebaa1c", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "40006fb1-ce5a-490e-befb-ff529aa0565b", "CustomerId": "e2fc62d5-6646-4b70-8924-7b1f8eebaa1c", "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": "31fa136c-e184-4d2d-9c8d-e8f958cef5df", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": {}, "PricingGroupId": {}, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2024-11-07T08:49:36.9073949+00:00" }