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": "8ea22ec9-7af4-43b5-9bba-1081e03b15c5", "CustomerId": "70c93652-9f7b-4440-8ab6-7627afe4cf79", "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": "8ea22ec9-7af4-43b5-9bba-1081e03b15c5", "CustomerId": "70c93652-9f7b-4440-8ab6-7627afe4cf79", "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": "cc17f7c8-a061-4008-9ee0-dbfcf2b44785", "CustomerId": "75ead521-d80d-4480-b698-f421e830297f", "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": "cc17f7c8-a061-4008-9ee0-dbfcf2b44785", "CustomerId": "75ead521-d80d-4480-b698-f421e830297f", "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": "910feb93-162a-4f70-802a-0b40d67c9688", "CustomerId": "790efd32-525f-4e12-b4f4-6c2aec1d0ea8", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "910feb93-162a-4f70-802a-0b40d67c9688", "CustomerId": "790efd32-525f-4e12-b4f4-6c2aec1d0ea8", "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-06-10T09:14:53.5839389+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-06-10T09:14:53.5839389+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-06-10T09:14:53.5839389+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-06-10T09:14:53.5839389+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "0b3793f1-4c39-4bee-99d6-37fe5c559d57", "b715ac73-07d9-41a8-9df2-b95fd460c6f6" ], "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": "816a541f-61f0-4985-b2da-481f26b01fb3", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "sample string 12", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": "21da46a3-0f9b-4a74-9c07-0032294dfd6b", "LastModifiedDateUtc": "2025-06-10T09:14:53.5839389+00:00" }