GET api/crmconnect/widgetsearch/companies?postponed={postponed}&active={active}&archived={archived}&hasAddress={hasAddress}&hasTelephone={hasTelephone}&hasEmail={hasEmail}&searchDate={searchDate}&descending={descending}&top={top}
Select sets of companies x at a time, for the migration assistant widget 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 |
|---|---|---|---|
| postponed |
The postponed value supplied with the request. |
boolean |
Default value is False |
| active |
The active value supplied with the request. |
boolean |
Default value is True |
| archived |
The archived value supplied with the request. |
boolean |
Default value is False |
| hasAddress |
The has address value supplied with the request. |
boolean |
Default value is False |
| hasTelephone |
The has telephone value supplied with the request. |
boolean |
Default value is False |
| hasEmail |
The has email value supplied with the request. |
boolean |
Default value is False |
| searchDate |
The search date value supplied with the request. |
date |
None. |
| descending |
The descending value supplied with the request. |
boolean |
Default value is True |
| top |
The top value supplied with the request. |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
Collection of CrmConnectWidgetSearchCompanyDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyType |
The company type value. |
string |
None. |
| CompanyName |
The company name value. |
string |
None. |
|
The email value. |
string |
None. |
|
| Created |
The created value. |
string |
None. |
| LastContacted |
The last contacted value. |
string |
None. |
| Postponed |
Indicates whether postponed is true. |
boolean |
None. |
| Import |
Indicates whether import is true. |
boolean |
None. |
| Edit |
Indicates whether edit is true. |
boolean |
None. |
| Importing |
Indicates whether importing is true. |
boolean |
None. |
| Status |
The status value. |
string |
None. |
| Deleted |
Indicates whether deleted is true. |
boolean |
None. |
| 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
[
{
"CompanyType": "sample string 1",
"CompanyName": "sample string 2",
"Email": "sample string 3",
"Created": "sample string 4",
"LastContacted": "sample string 5",
"Postponed": true,
"Import": true,
"Edit": true,
"Importing": true,
"Status": "sample string 10",
"Deleted": true,
"Names": [
"sample string 1",
"sample string 2"
],
"Phone": "sample string 12",
"Address": "sample string 13",
"NavigationContextJson": "sample string 14"
},
{
"CompanyType": "sample string 1",
"CompanyName": "sample string 2",
"Email": "sample string 3",
"Created": "sample string 4",
"LastContacted": "sample string 5",
"Postponed": true,
"Import": true,
"Edit": true,
"Importing": true,
"Status": "sample string 10",
"Deleted": true,
"Names": [
"sample string 1",
"sample string 2"
],
"Phone": "sample string 12",
"Address": "sample string 13",
"NavigationContextJson": "sample string 14"
}
]