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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
term

string

Required

excludeArchived

boolean

Default value is True

excludeDeleted

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of Dezrez.Core.DataContracts.External.Api.CrmConnect.CrmConnectGlobalSearchPeopleDataContract
NameDescriptionTypeAdditional information
Names

Collection of string

None.

Phone

string

None.

Address

string

None.

NavigationContextJson

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"
  }
]