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 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 | string |
None. |
|
Notes | string |
None. |
|
UniqueIdentifier | string |
None. |
|
Id | globally unique identifier |
None. |
|
CustomerTypeId | integer |
None. |
|
CustomerType | string |
None. |
|
DateOfBirth | date |
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": "a3207a3e-c1c4-406b-887b-d94698af006a", "CustomerId": "72f201c4-25dd-498b-b5cb-43983c8cb4d2", "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": "a3207a3e-c1c4-406b-887b-d94698af006a", "CustomerId": "72f201c4-25dd-498b-b5cb-43983c8cb4d2", "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": "71a195e4-3f01-4dc6-aca4-9d4bb8653d88", "CustomerId": "6042afec-83e4-4795-9484-fd9531797fbd", "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": "71a195e4-3f01-4dc6-aca4-9d4bb8653d88", "CustomerId": "6042afec-83e4-4795-9484-fd9531797fbd", "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": "eb029a76-c078-44eb-a03a-2bd9e6b844a8", "CustomerId": "7194886a-fce6-4818-b820-9c64c1217a76", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "eb029a76-c078-44eb-a03a-2bd9e6b844a8", "CustomerId": "7194886a-fce6-4818-b820-9c64c1217a76", "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": "sample string 6", "Notes": "sample string 7", "UniqueIdentifier": "sample string 8", "Id": "e3c345cc-aed5-4d11-bd75-dc932bebf074", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2024-11-25T11:52:45.1882885+00:00", "PricingGroupId": {}, "Disabled": true, "DoNotContact": true, "Version": 15, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2024-11-25T11:52:45.1882885+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": "a3207a3e-c1c4-406b-887b-d94698af006a", "CustomerId": "72f201c4-25dd-498b-b5cb-43983c8cb4d2", "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": "a3207a3e-c1c4-406b-887b-d94698af006a", "CustomerId": "72f201c4-25dd-498b-b5cb-43983c8cb4d2", "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": "71a195e4-3f01-4dc6-aca4-9d4bb8653d88", "CustomerId": "6042afec-83e4-4795-9484-fd9531797fbd", "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": "71a195e4-3f01-4dc6-aca4-9d4bb8653d88", "CustomerId": "6042afec-83e4-4795-9484-fd9531797fbd", "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": "eb029a76-c078-44eb-a03a-2bd9e6b844a8", "CustomerId": "7194886a-fce6-4818-b820-9c64c1217a76", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "eb029a76-c078-44eb-a03a-2bd9e6b844a8", "CustomerId": "7194886a-fce6-4818-b820-9c64c1217a76", "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": "sample string 6", "Notes": "sample string 7", "UniqueIdentifier": "sample string 8", "Id": "e3c345cc-aed5-4d11-bd75-dc932bebf074", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2024-11-25T11:52:45.1882885+00:00", "PricingGroupId": {}, "Disabled": true, "DoNotContact": true, "Version": 15, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2024-11-25T11:52:45.1882885+00:00" } ]