GET v1/Companies({CompanyId})/SearchCapabilites
This call returns SearchCapabilities which can be used with the /Search endpoint
Information:
Base URL:
https://api.covasoft.net/crm
Example of a call would be:
https://api{{en}}.covasoft.net/crm/v1/Companies({{CompanyId}})/SearchCapabilites
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
A collection of SearchCapabilities
CustomerSearchCapabilitiesName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
Field |
The name/description of the field |
string |
None. |
Operations |
The available search operations for this field |
Collection of string |
None. |
DefaultOperation |
The operation that will be used for this field by default |
string |
None. |
AllowMultiple |
Indicates if this field can be combined with other fields in a search |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": 1, "Field": "sample string 2", "Operations": [ "sample string 1", "sample string 2" ], "DefaultOperation": "sample string 3", "AllowMultiple": true }