GET api/company?IsConsumer={IsConsumer}&IsProspect={IsProspect}&IsOperator={IsOperator}&IsSupplier={IsSupplier}&IsReseller={IsReseller}&IsCarrier={IsCarrier}&IsAgent={IsAgent}&IsCustomer={IsCustomer}
This method returns a list of companies.
Error Messages
- 401/Unauthorized - Authorization has been denied for this request.
- 404/Not Found - No companies Found.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IsConsumer | Indicates whether the company is a consumer | boolean |
None. |
| IsProspect | Indicates whether the company is a prospect | boolean |
None. |
| IsOperator | Indicates whether the company is an operator | boolean |
None. |
| IsSupplier | Indicates whether the company is a supplier | boolean |
None. |
| IsReseller | Indicates whether the company is a reseller | boolean |
None. |
| IsCarrier | Indicates whether the company is a carrier | boolean |
None. |
| IsAgent | Indicates whether the company is an agent | boolean |
None. |
| IsCustomer | Indicates whether the company is a customer | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of companies
Collection of CompanyView| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The Company ID | integer |
None. |
| CustomProperties | Custom controls created with the Service Designer | Collection of EntityCustomPropertyView |
None. |
| LastUpdated | The date the Company was last updated | date |
None. |
| Name | The name of the company | string |
String length: inclusive between 0 and 50 |
| IsCustomer | Indicates whether the company is a customer | boolean |
None. |
| IsAgent | Indicates whether the company is an Agent | boolean |
None. |
| IsCarrier | Indicates whether the company is a Carrier | boolean |
None. |
| IsReseller | Indicates whether the company is a Reseller | boolean |
None. |
| IsSupplier | Indicates whether the company is a Supplier | boolean |
None. |
| IsOperator | Indicates whether the company is a Operator | boolean |
None. |
| IsProspect | Indicates whether the company is a Prospect | boolean |
None. |
| DateSigned | Date the customer was signed up | date |
None. |
| DateReceived | Date the customer's sign up information was entered into the system | date |
None. |
| DateLive | Date the customer was/will be live | date |
None. |
| LastContacted | Date the customer was last contacted | date |
None. |
| IsConsumer | Indicates whether the company is a consumer | boolean |
None. |