Excerpt |
---|
This method returns information related with a lead. A single lead is returned by each call |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Lead identifier
The identifier of the lead that should be returned as a result. The allowed lead identifier fields are the following:
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||
---|---|---|
| ||
Code Block | ||
| ||
Excerpt | ||
This method returns information related with a lead. A single lead is returned by each call |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
lead_identifier (mandatory) | Lead identifier | The identifier of the lead that should be returned as a result. The allowed lead identifier fields are the following:
| ||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | |||||
---|---|---|---|---|---|
| |||||
HTTP Method: GET
Response:
|
Expand | |||||
---|---|---|---|---|---|
| |||||
HTTP Method: GET
Request: {{server}}/crmapi/rest/v2/leads/show?token={{token}}&lead_identifier=number=116 Response:
|