GET v1/Companies({CompanyId})/Customers

This call returns all the Customers in a Company

Information:

Base URL:

https://api.covasoft.net/crm

Example of a call would be:

https://api.covasoft.net/crm/v1/Companies({{CompanyId}})/Customers?$skip=0&$top=100
Paging accomplished with $top & $skip. Maximum of 100 customers per page

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Returns all the Customers in a Company

Collection of CustomersByCompanyReturn

Name	Type	Additional information
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	integer	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": "sample string 6",
    "Notes": "sample string 7",
    "UniqueIdentifier": "sample string 8",
    "Id": "45a71e52-0253-439e-9a6f-6e1f7582a928",
    "CustomerTypeId": 10,
    "CustomerType": "sample string 11",
    "DateOfBirth": "2024-11-07T08:40:47.251224+00:00",
    "PricingGroupId": 1,
    "Disabled": true,
    "DoNotContact": true,
    "Version": 14,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-07T08:40:47.251224+00:00"
  },
  {
    "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": "45a71e52-0253-439e-9a6f-6e1f7582a928",
    "CustomerTypeId": 10,
    "CustomerType": "sample string 11",
    "DateOfBirth": "2024-11-07T08:40:47.251224+00:00",
    "PricingGroupId": 1,
    "Disabled": true,
    "DoNotContact": true,
    "Version": 14,
    "MergedIntoCustomerId": {},
    "LastModifiedDateUtc": "2024-11-07T08:40:47.251224+00:00"
  }
]