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 CustomersByLastModifedDateReturn| Name | 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": "1d39ec46-a18d-4448-b801-632cfd32de31",
"CustomerId": "05ee7ec7-1614-49fe-9758-e02329aed679",
"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": "1d39ec46-a18d-4448-b801-632cfd32de31",
"CustomerId": "05ee7ec7-1614-49fe-9758-e02329aed679",
"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": "53ecb874-1b29-44b6-947f-1dca58ee4e1f",
"CustomerId": "e7e746e6-7ce0-44a1-8f3a-ba60d6c72e61",
"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": "53ecb874-1b29-44b6-947f-1dca58ee4e1f",
"CustomerId": "e7e746e6-7ce0-44a1-8f3a-ba60d6c72e61",
"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": "f6b489c2-8a61-4b49-9597-46e82e0658e6",
"CustomerId": "86b3da9c-4367-4ae9-9d4e-fbd6a9b044c8",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "f6b489c2-8a61-4b49-9597-46e82e0658e6",
"CustomerId": "86b3da9c-4367-4ae9-9d4e-fbd6a9b044c8",
"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-11-21T14:58:42.714393+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-11-21T14:58:42.714393+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-11-21T14:58:42.714393+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-11-21T14:58:42.714393+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"f5f727e5-077b-4069-b456-f8c45e5b2c13",
"99ec6411-058a-4f0a-95d3-cde4ace44317"
],
"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": "fdc3cc51-e316-47a5-981a-44ad6fde08b8",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2025-11-21T14:58:42.714393+00:00",
"PricingGroupId": 12,
"Disabled": true,
"DoNotContact": true,
"Version": 15,
"MergedIntoCustomerId": "7736064b-8ac6-4872-b963-dda672c5ef06",
"LastModifiedDateUtc": "2025-11-21T14:58:42.714393+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": "1d39ec46-a18d-4448-b801-632cfd32de31",
"CustomerId": "05ee7ec7-1614-49fe-9758-e02329aed679",
"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": "1d39ec46-a18d-4448-b801-632cfd32de31",
"CustomerId": "05ee7ec7-1614-49fe-9758-e02329aed679",
"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": "53ecb874-1b29-44b6-947f-1dca58ee4e1f",
"CustomerId": "e7e746e6-7ce0-44a1-8f3a-ba60d6c72e61",
"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": "53ecb874-1b29-44b6-947f-1dca58ee4e1f",
"CustomerId": "e7e746e6-7ce0-44a1-8f3a-ba60d6c72e61",
"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": "f6b489c2-8a61-4b49-9597-46e82e0658e6",
"CustomerId": "86b3da9c-4367-4ae9-9d4e-fbd6a9b044c8",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "f6b489c2-8a61-4b49-9597-46e82e0658e6",
"CustomerId": "86b3da9c-4367-4ae9-9d4e-fbd6a9b044c8",
"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-11-21T14:58:42.714393+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-11-21T14:58:42.714393+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-11-21T14:58:42.714393+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-11-21T14:58:42.714393+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"f5f727e5-077b-4069-b456-f8c45e5b2c13",
"99ec6411-058a-4f0a-95d3-cde4ace44317"
],
"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": "fdc3cc51-e316-47a5-981a-44ad6fde08b8",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2025-11-21T14:58:42.714393+00:00",
"PricingGroupId": 12,
"Disabled": true,
"DoNotContact": true,
"Version": 15,
"MergedIntoCustomerId": "7736064b-8ac6-4872-b963-dda672c5ef06",
"LastModifiedDateUtc": "2025-11-21T14:58:42.714393+00:00"
}
]