GET api/crmconnect/globalsearch/companies?term={term}&excludeArchived={excludeArchived}&excludeDeleted={excludeDeleted}
Api to search the crm for companies and return values in a format acceptable by the rezi global search Processes this crm connect API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| term |
The term value supplied with the request. |
string |
Required |
| excludeArchived |
The exclude archived value supplied with the request. |
boolean |
Default value is True |
| excludeDeleted |
The exclude deleted value supplied with the request. |
boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
Collection of CrmConnectGlobalSearchPeopleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Names |
The collection of names. |
Collection of string |
None. |
| Phone |
The phone value. |
string |
None. |
| Address |
The address value. |
string |
None. |
| NavigationContextJson |
The navigation context json value. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Names": [
"sample string 1",
"sample string 2"
],
"Phone": "sample string 1",
"Address": "sample string 2",
"NavigationContextJson": "sample string 3"
},
{
"Names": [
"sample string 1",
"sample string 2"
],
"Phone": "sample string 1",
"Address": "sample string 2",
"NavigationContextJson": "sample string 3"
}
]