Available from CRM.COM R9.0.0
This method returns the competitors that are allowed to be used by leads of any or all types. All Competitors defined in the active Lead Definitions are retrieved if no type is defined. Multiple competitors are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
lead_type_identifier (optional) | Lead Type Identifier | The identifier of the type of the lead that will be using the competitors. The competitors are filtered against the allowed competitors of the specified type. The allowed lead type identifier fields are the following:
Available from CRM.COM R14.0.0 | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved lead competitor |
name | String | The name of the retrieved lead competitor |
website | String | The website of the retrieved competitor |
| description | String | The description of the retrieved lead competitor |
Examples
HTTP Method: GET
Request:
Response:
{
"id": "F0EE8EDCD868415184CCAD6221E356B6",
"name": "Chargify",
"website": "www.chargify.com",
"description": "Chargify: CRM"
},
{
"id": "920ABF722D304B8890312E6C3241A062",
"name": "Rewards Tool",
"website": "www.competitor2.com",
"description": "Rewards Tool: Rewards"
}