Skip to end of banner
Go to start of banner

GET leads/configuration/competitors/list

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Available from CRM.COM R9.0.0

This method returns the competitors that are allowed to be used by leads of any type. All Competitors defined in the active Lead Definitions are retrieved. Multiple competitors are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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 

descriptionStringThe description of the retrieved lead competitor

Examples

 Example 1

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"
   }
  • No labels