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. |
|
MemberOf | Collection of MemberOf |
None. |
|
Documents | Collection of Document |
None. |
|
MergedCustomers | Collection of globally unique identifier |
None. |
|
PrimaryName | string |
None. |
|
Title | string |
None. |
|
AlternateName | string |
None. |
|
MiddleName | string |
None. |
|
FamilyName | string |
None. |
|
ReferralSource | string |
None. |
|
Notes | string |
None. |
|
UniqueIdentifier | string |
None. |
|
Id | globally unique identifier |
None. |
|
CustomerTypeId | integer |
None. |
|
CustomerType | string |
None. |
|
DateOfBirth | string |
None. |
|
PricingGroupId | integer |
None. |
|
Disabled | boolean |
None. |
|
DoNotContact | boolean |
None. |
|
Version | integer |
None. |
|
MergedIntoCustomerId | globally unique identifier |
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": "6f94ee59-e38f-4e9c-b61c-9ff465ff6448", "CustomerId": "e1e4869f-b01a-478e-b457-8727e4ab2445", "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": "6f94ee59-e38f-4e9c-b61c-9ff465ff6448", "CustomerId": "e1e4869f-b01a-478e-b457-8727e4ab2445", "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": "1ae556fa-d2aa-4493-b586-7e2731d4dd87", "CustomerId": "748aa245-5fbc-4ea7-8a7c-ea8632949bb0", "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": "1ae556fa-d2aa-4493-b586-7e2731d4dd87", "CustomerId": "748aa245-5fbc-4ea7-8a7c-ea8632949bb0", "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": "b9582111-a568-475f-a736-eb3c25e282af", "CustomerId": "d29fc0f3-6699-4fef-b9df-e101c53673bc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "b9582111-a568-475f-a736-eb3c25e282af", "CustomerId": "d29fc0f3-6699-4fef-b9df-e101c53673bc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 } ], "MemberOf": [ { "Id": "sample string 1", "ChildCustomerId": "sample string 2" }, { "Id": "sample string 1", "ChildCustomerId": "sample string 2" } ], "Documents": [ { "Id": "sample string 1", "CustomerId": "sample string 2", "DocumentType": "sample string 3", "DocumentTypeId": 4, "DocumentClassification": "sample string 5", "DocumentClassificationId": 6, "Name": "sample string 7", "MimeType": "sample string 8", "AddedBy": "sample string 9", "DatedAddedUtc": "2025-10-10T18:50:52.8735779+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-10-10T18:50:52.8735779+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" }, { "Id": "sample string 1", "CustomerId": "sample string 2", "DocumentType": "sample string 3", "DocumentTypeId": 4, "DocumentClassification": "sample string 5", "DocumentClassificationId": 6, "Name": "sample string 7", "MimeType": "sample string 8", "AddedBy": "sample string 9", "DatedAddedUtc": "2025-10-10T18:50:52.8735779+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-10-10T18:50:52.8735779+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "f713f4cf-f008-4eb4-b065-ddf8b3c4c224", "43a7c0d4-2a45-4d41-9ce2-440ad9ae7002" ], "PrimaryName": "sample string 1", "Title": "sample string 2", "AlternateName": "sample string 3", "MiddleName": "sample string 4", "FamilyName": "sample string 5", "ReferralSource": "sample string 6", "Notes": "sample string 7", "UniqueIdentifier": "sample string 8", "Id": "368cf0c4-e241-4acb-b6a0-e82b7ba01c3d", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "sample string 12", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": "3a18ffc0-474b-4f78-9869-e8730405cb11", "LastModifiedDateUtc": "2025-10-10T18:50:52.8735779+00:00" }