GET v1/Companies({CompanyId})/CustomerSearch?filterCriteria={filterCriteria}

This call returns the Customers that match your Search Criteria

Information:

Base URL:

https://api.covasoft.net/crm

Example of a call would be:

https://api.covasoft.net/crm/v1/Companies({CompanyId})/CustomerSearch?$filter=Criteria eq 'Peter.Smith@email.com'

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	Company Id from your onboarding package	integer	Required
filterCriteria	This is fitering criteria for your Customer Search	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns Customers that match your Search Criteria

Collection of CustomerSearchUsingFilteringReturn

Name	Type	Additional information
Criteria	string	None.
Addresses	Collection of Object	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	Object	None.
AlternateName	Object	None.
MiddleName	Object	None.
FamilyName	string	None.
ReferralSource	Object	None.
Notes	Object	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	Object	None.
LastModifiedDateUtc	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Criteria": "sample string 1",
    "Addresses": [
      {},
      {}
    ],
    "ContactMethods": [
      {
        "Value": "sample string 1",
        "Id": "5ad264d0-8ced-4234-8e13-bc4695dfef29",
        "CustomerId": "3a80affd-0993-41d3-b3b8-910cea3ab10e",
        "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": "5ad264d0-8ced-4234-8e13-bc4695dfef29",
        "CustomerId": "3a80affd-0993-41d3-b3b8-910cea3ab10e",
        "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": "fa55afd3-f176-45ed-932d-8b6818f2aab3",
        "CustomerId": "dbda142a-8744-4b32-a72d-41c17fa47363",
        "ExtensionTypeId": 4,
        "ExtensionType": "sample string 5",
        "ExtensionTypeFeature": "sample string 6",
        "Version": 7
      },
      {
        "Value": "sample string 1",
        "Id": "fa55afd3-f176-45ed-932d-8b6818f2aab3",
        "CustomerId": "dbda142a-8744-4b32-a72d-41c17fa47363",
        "ExtensionTypeId": 4,
        "ExtensionType": "sample string 5",
        "ExtensionTypeFeature": "sample string 6",
        "Version": 7
      }
    ],
    "RelatedCustomers": [
      {},
      {}
    ],
    "MemberOf": [
      {},
      {}
    ],
    "Documents": [
      {},
      {}
    ],
    "MergedCustomers": [
      {},
      {}
    ],
    "PrimaryName": "sample string 2",
    "Title": {},
    "AlternateName": {},
    "MiddleName": {},
    "FamilyName": "sample string 6",
    "ReferralSource": {},
    "Notes": {},
    "UniqueIdentifier": "sample string 9",
    "Id": "6cf3a3a6-9d4f-4de1-b5db-5d765b0ebadc",
    "CustomerTypeId": 11,
    "CustomerType": "sample string 12",
    "DateOfBirth": "2024-11-25T11:29:50.3335894+00:00",
    "PricingGroupId": 14,
    "Disabled": true,
    "DoNotContact": true,
    "Version": 17,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-25T11:29:50.3335894+00:00"
  },
  {
    "Criteria": "sample string 1",
    "Addresses": [
      {},
      {}
    ],
    "ContactMethods": [
      {
        "Value": "sample string 1",
        "Id": "5ad264d0-8ced-4234-8e13-bc4695dfef29",
        "CustomerId": "3a80affd-0993-41d3-b3b8-910cea3ab10e",
        "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": "5ad264d0-8ced-4234-8e13-bc4695dfef29",
        "CustomerId": "3a80affd-0993-41d3-b3b8-910cea3ab10e",
        "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": "fa55afd3-f176-45ed-932d-8b6818f2aab3",
        "CustomerId": "dbda142a-8744-4b32-a72d-41c17fa47363",
        "ExtensionTypeId": 4,
        "ExtensionType": "sample string 5",
        "ExtensionTypeFeature": "sample string 6",
        "Version": 7
      },
      {
        "Value": "sample string 1",
        "Id": "fa55afd3-f176-45ed-932d-8b6818f2aab3",
        "CustomerId": "dbda142a-8744-4b32-a72d-41c17fa47363",
        "ExtensionTypeId": 4,
        "ExtensionType": "sample string 5",
        "ExtensionTypeFeature": "sample string 6",
        "Version": 7
      }
    ],
    "RelatedCustomers": [
      {},
      {}
    ],
    "MemberOf": [
      {},
      {}
    ],
    "Documents": [
      {},
      {}
    ],
    "MergedCustomers": [
      {},
      {}
    ],
    "PrimaryName": "sample string 2",
    "Title": {},
    "AlternateName": {},
    "MiddleName": {},
    "FamilyName": "sample string 6",
    "ReferralSource": {},
    "Notes": {},
    "UniqueIdentifier": "sample string 9",
    "Id": "6cf3a3a6-9d4f-4de1-b5db-5d765b0ebadc",
    "CustomerTypeId": 11,
    "CustomerType": "sample string 12",
    "DateOfBirth": "2024-11-25T11:29:50.3335894+00:00",
    "PricingGroupId": 14,
    "Disabled": true,
    "DoNotContact": true,
    "Version": 17,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-25T11:29:50.3335894+00:00"
  }
]