GET v1/Companies({CompanyId})/CustomerFull?LastModifiedDateUtc={LastModifiedDateUtc}
This call returns all the Customers that have been Added or Modified since the DateTime Provided
Information:
Base URL:
https://api.covasoft.net/crm
Example of a call would be:
https://api.covasoft.net/crm/v1/Companies({CompanyId})/CustomerFull?$filter=LastModifiedDateUtc ge datetime'2019-01-01T00:00:00z'
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
Company Id from your onboarding package |
integer |
Required |
LastModifiedDateUtc |
This Date would be the last Datetime you polled for changes |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns Customers that have been Added or Modified since the DateTime Provided
Collection of CustomersByLastModifedDateReturnName | Description | Type | Additional information |
---|---|---|---|
Addresses | Collection of Address |
None. |
|
ContactMethods | Collection of ContactMethod |
None. |
|
CustomerExtensions | Collection of CustomerExtension |
None. |
|
RelatedCustomers | Collection of RelatedCustomer |
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 | date |
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": "a32e97a1-d43b-49ad-96e6-01aac194514b", "CustomerId": "9ce8bb73-00cc-49c8-b81e-013bfdee1fe9", "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": "a32e97a1-d43b-49ad-96e6-01aac194514b", "CustomerId": "9ce8bb73-00cc-49c8-b81e-013bfdee1fe9", "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": "0884dc41-7d15-420a-89c4-368bd654b113", "CustomerId": "e720cb18-3af7-441b-a771-f10d2a2796e8", "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": "0884dc41-7d15-420a-89c4-368bd654b113", "CustomerId": "e720cb18-3af7-441b-a771-f10d2a2796e8", "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": "02c69ef5-01f5-4db1-afb3-c246cdfe9617", "CustomerId": "543480a0-7b32-4864-8546-e27ef672f7fc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "02c69ef5-01f5-4db1-afb3-c246cdfe9617", "CustomerId": "543480a0-7b32-4864-8546-e27ef672f7fc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 } ], "RelatedCustomers": [ { "Id": "sample string 1", "ParentCustomerId": "sample string 2" }, { "Id": "sample string 1", "ParentCustomerId": "sample string 2" } ], "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-07-01T00:09:31.2223427+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-01T00:09:31.2223427+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-07-01T00:09:31.2223427+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-01T00:09:31.2223427+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "ed686309-38bc-453f-bb1f-203e9a910087", "84ad9c4f-adf7-41fc-9d54-18038ad60eaf" ], "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": "620aa353-e5e3-4e2e-bccd-ffa2891a9b60", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-07-01T00:09:31.2223427+00:00", "PricingGroupId": 12, "Disabled": true, "DoNotContact": true, "Version": 15, "MergedIntoCustomerId": "c7b32eb8-7133-46e3-a967-c6e25fa6c7d1", "LastModifiedDateUtc": "2025-07-01T00:09:31.2223427+00:00" }, { "Addresses": [ { "AddressLine1": "sample string 1", "AddressLine2": "sample string 2", "City": "sample string 3", "StateName": "sample string 4", "CountryName": "sample string 5", "Zip": 1, "Id": "a32e97a1-d43b-49ad-96e6-01aac194514b", "CustomerId": "9ce8bb73-00cc-49c8-b81e-013bfdee1fe9", "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": "a32e97a1-d43b-49ad-96e6-01aac194514b", "CustomerId": "9ce8bb73-00cc-49c8-b81e-013bfdee1fe9", "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": "0884dc41-7d15-420a-89c4-368bd654b113", "CustomerId": "e720cb18-3af7-441b-a771-f10d2a2796e8", "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": "0884dc41-7d15-420a-89c4-368bd654b113", "CustomerId": "e720cb18-3af7-441b-a771-f10d2a2796e8", "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": "02c69ef5-01f5-4db1-afb3-c246cdfe9617", "CustomerId": "543480a0-7b32-4864-8546-e27ef672f7fc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "02c69ef5-01f5-4db1-afb3-c246cdfe9617", "CustomerId": "543480a0-7b32-4864-8546-e27ef672f7fc", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 } ], "RelatedCustomers": [ { "Id": "sample string 1", "ParentCustomerId": "sample string 2" }, { "Id": "sample string 1", "ParentCustomerId": "sample string 2" } ], "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-07-01T00:09:31.2223427+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-01T00:09:31.2223427+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-07-01T00:09:31.2223427+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-01T00:09:31.2223427+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "ed686309-38bc-453f-bb1f-203e9a910087", "84ad9c4f-adf7-41fc-9d54-18038ad60eaf" ], "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": "620aa353-e5e3-4e2e-bccd-ffa2891a9b60", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-07-01T00:09:31.2223427+00:00", "PricingGroupId": 12, "Disabled": true, "DoNotContact": true, "Version": 15, "MergedIntoCustomerId": "c7b32eb8-7133-46e3-a967-c6e25fa6c7d1", "LastModifiedDateUtc": "2025-07-01T00:09:31.2223427+00:00" } ]