POST v1/Companies({CompanyId})/Search

This call returns Customers which match supplied criteria.

Information:

Base URL:

https://api.covasoft.net/crm

Example of a call would be:

https://api{{en}}.covasoft.net/crm/v1/Companies({{CompanyId}})/Search

See Search Capabilities.
To minimize customer duplication, we recommend searching by multiple criteria. Phone and Contact (email address) are a good start, but are not constrained to be unique. All critera must match for records to be returned. To avoid false negatives, search by Phone and Contact separately and perform additional matching within your solution depending on the customer data you capture.

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	Company Id from your onboarding package	integer	Required

Body Parameters

CustomerSearchRequest

Name	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

The POSTed CustomerSearchCriteria collection and a collection of CustomerFull records matching the criteria

CustomerSearchResult

Name	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": "59ce2abd-d698-45b0-9c41-811dd9cae350",
          "CustomerId": "731fcd28-ed5e-4375-9c63-4c9cda7d07e2",
          "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": "59ce2abd-d698-45b0-9c41-811dd9cae350",
          "CustomerId": "731fcd28-ed5e-4375-9c63-4c9cda7d07e2",
          "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": "7e32c36d-289c-47a0-ba8a-1332d48cad79",
          "CustomerId": "654bda27-17c2-4409-b2a9-7a3e95eb0aee",
          "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": "7e32c36d-289c-47a0-ba8a-1332d48cad79",
          "CustomerId": "654bda27-17c2-4409-b2a9-7a3e95eb0aee",
          "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": "3284574c-6e0e-49fc-817d-148804b1af0b",
          "CustomerId": "9449e85f-cc32-423c-b0e9-6f72dfb14762",
          "ExtensionTypeId": 4,
          "ExtensionType": "sample string 5",
          "ExtensionTypeFeature": "sample string 6",
          "Version": 7
        },
        {
          "Value": "sample string 1",
          "Id": "3284574c-6e0e-49fc-817d-148804b1af0b",
          "CustomerId": "9449e85f-cc32-423c-b0e9-6f72dfb14762",
          "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": "c9e2a476-9d77-4f5d-83e4-9b13089102cb",
      "CustomerTypeId": 10,
      "CustomerType": "sample string 11",
      "DateOfBirth": "2025-01-18T05:15:02.3756142+00:00",
      "PricingGroupId": 13,
      "Disabled": true,
      "DoNotContact": true,
      "Version": 16,
      "MergedIntoCustomerId": {},
      "LastModifiedDateUtc": "2025-01-18T05:15:02.3756142+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": "59ce2abd-d698-45b0-9c41-811dd9cae350",
          "CustomerId": "731fcd28-ed5e-4375-9c63-4c9cda7d07e2",
          "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": "59ce2abd-d698-45b0-9c41-811dd9cae350",
          "CustomerId": "731fcd28-ed5e-4375-9c63-4c9cda7d07e2",
          "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": "7e32c36d-289c-47a0-ba8a-1332d48cad79",
          "CustomerId": "654bda27-17c2-4409-b2a9-7a3e95eb0aee",
          "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": "7e32c36d-289c-47a0-ba8a-1332d48cad79",
          "CustomerId": "654bda27-17c2-4409-b2a9-7a3e95eb0aee",
          "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": "3284574c-6e0e-49fc-817d-148804b1af0b",
          "CustomerId": "9449e85f-cc32-423c-b0e9-6f72dfb14762",
          "ExtensionTypeId": 4,
          "ExtensionType": "sample string 5",
          "ExtensionTypeFeature": "sample string 6",
          "Version": 7
        },
        {
          "Value": "sample string 1",
          "Id": "3284574c-6e0e-49fc-817d-148804b1af0b",
          "CustomerId": "9449e85f-cc32-423c-b0e9-6f72dfb14762",
          "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": "c9e2a476-9d77-4f5d-83e4-9b13089102cb",
      "CustomerTypeId": 10,
      "CustomerType": "sample string 11",
      "DateOfBirth": "2025-01-18T05:15:02.3756142+00:00",
      "PricingGroupId": 13,
      "Disabled": true,
      "DoNotContact": true,
      "Version": 16,
      "MergedIntoCustomerId": {},
      "LastModifiedDateUtc": "2025-01-18T05:15:02.3756142+00:00"
    }
  ]
}