POST v1/Companies({CompanyId})/Search
This call returns Customers which match supplied criteria and is more versatile than the /CustomerSearch endpoint
Information:
Base URL:
https://api.covasoft.net/crm
Example of a call would be:
https://api{{en}}.covasoft.net/crm/v1/Companies({{CompanyId}})/Search
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
Company Id from your onboarding package |
integer |
Required |
Body Parameters
CustomerSearchUsingMultipleExtensionsPostName | Description | Type | Additional information |
---|---|---|---|
Criteria | Collection of CustomerSearchCriteria |
None. |
Request Formats
application/json, text/json
Sample:
{ "Criteria": [ { "Criteria": "sample string 1", "Field": "sample string 2", "Operation": "sample string 3" }, { "Criteria": "sample string 1", "Field": "sample string 2", "Operation": "sample string 3" } ] }
Response Information
Resource Description
An Id, the CustomerSearchCriteria collection from the POST and a collection of CustomerFull records matching the search
CustomerSearchUsingMultipleExtensionsResultName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Criteria | Collection of CustomerSearchCriteria |
None. |
|
Results | Collection of CustomerFullReturn |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "Criteria": [ { "Criteria": "sample string 1", "Field": "sample string 2", "Operation": "sample string 3" }, { "Criteria": "sample string 1", "Field": "sample string 2", "Operation": "sample string 3" } ], "Results": [ { "Addresses": [ { "AddressLine1": "sample string 1", "AddressLine2": "sample string 2", "City": "sample string 3", "StateName": "sample string 4", "CountryName": "sample string 5", "Zip": 1, "Id": "8a8e936a-a801-4602-baff-810fdee184a7", "CustomerId": "4de4b8a3-67a5-4cff-bcf6-e2a7f0ccacb6", "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": "8a8e936a-a801-4602-baff-810fdee184a7", "CustomerId": "4de4b8a3-67a5-4cff-bcf6-e2a7f0ccacb6", "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": "f95bc537-b343-443b-b55c-89643ab20cf3", "CustomerId": "08e371c8-825c-4b6a-84e0-1891606cc2f1", "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": "f95bc537-b343-443b-b55c-89643ab20cf3", "CustomerId": "08e371c8-825c-4b6a-84e0-1891606cc2f1", "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": "56312f13-63f7-4f06-b19d-baf7edfa7eca", "CustomerId": "e003ee0c-4f9e-4e55-84f1-404d6b8ceff9", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "56312f13-63f7-4f06-b19d-baf7edfa7eca", "CustomerId": "e003ee0c-4f9e-4e55-84f1-404d6b8ceff9", "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": "e7e258c1-cdbb-4d66-87be-ad115385fe2d", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2024-11-25T11:21:38.3739065+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2024-11-25T11:21:38.3739065+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": "8a8e936a-a801-4602-baff-810fdee184a7", "CustomerId": "4de4b8a3-67a5-4cff-bcf6-e2a7f0ccacb6", "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": "8a8e936a-a801-4602-baff-810fdee184a7", "CustomerId": "4de4b8a3-67a5-4cff-bcf6-e2a7f0ccacb6", "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": "f95bc537-b343-443b-b55c-89643ab20cf3", "CustomerId": "08e371c8-825c-4b6a-84e0-1891606cc2f1", "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": "f95bc537-b343-443b-b55c-89643ab20cf3", "CustomerId": "08e371c8-825c-4b6a-84e0-1891606cc2f1", "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": "56312f13-63f7-4f06-b19d-baf7edfa7eca", "CustomerId": "e003ee0c-4f9e-4e55-84f1-404d6b8ceff9", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "56312f13-63f7-4f06-b19d-baf7edfa7eca", "CustomerId": "e003ee0c-4f9e-4e55-84f1-404d6b8ceff9", "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": "e7e258c1-cdbb-4d66-87be-ad115385fe2d", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2024-11-25T11:21:38.3739065+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2024-11-25T11:21:38.3739065+00:00" } ] }