GET v1/Companies({CompanyId})/Customers?UniqueIdentifier={UniqueIdentifier}

This call returns the Customer that has the Unique Indentifer Provided from an External System

Information:

Base URL:

https://api.covasoft.net/crm

Example of a call would be:

https://api.covasoft.net/crm/v1/Companies({CompanyId})/Customers?$filter=UniqueIdentifier eq '{UniqueIdentifier}'

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

Company Id from your onboarding package

integer

Required

UniqueIdentifier

This is a unique indentifer from an outside System

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns Customer that has the Unique Indentifer Provided from an External System

Collection of CustomerByUniqueIdentifierReturn
NameDescriptionTypeAdditional information
PrimaryName

string

None.

Title

string

None.

AlternateName

string

None.

MiddleName

string

None.

FamilyName

string

None.

ReferralSource

Object

None.

Notes

string

None.

UniqueIdentifier

string

None.

Id

globally unique identifier

None.

CustomerTypeId

integer

None.

CustomerType

string

None.

DateOfBirth

Object

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:
[
  {
    "PrimaryName": "sample string 1",
    "Title": "sample string 2",
    "AlternateName": "sample string 3",
    "MiddleName": "sample string 4",
    "FamilyName": "sample string 5",
    "ReferralSource": {},
    "Notes": "sample string 7",
    "UniqueIdentifier": "sample string 8",
    "Id": "1d668e46-fc7a-4a66-a949-76a64546372a",
    "CustomerTypeId": 10,
    "CustomerType": "sample string 11",
    "DateOfBirth": {},
    "PricingGroupId": {},
    "Disabled": true,
    "DoNotContact": true,
    "Version": 16,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-07T08:48:12.9185689+00:00"
  },
  {
    "PrimaryName": "sample string 1",
    "Title": "sample string 2",
    "AlternateName": "sample string 3",
    "MiddleName": "sample string 4",
    "FamilyName": "sample string 5",
    "ReferralSource": {},
    "Notes": "sample string 7",
    "UniqueIdentifier": "sample string 8",
    "Id": "1d668e46-fc7a-4a66-a949-76a64546372a",
    "CustomerTypeId": 10,
    "CustomerType": "sample string 11",
    "DateOfBirth": {},
    "PricingGroupId": {},
    "Disabled": true,
    "DoNotContact": true,
    "Version": 16,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-07T08:48:12.9185689+00:00"
  }
]