| Excerpt |
|---|
This method returns information related with leads. Multiple leads are returned by each call |
| Tip |
| Available from CRM.COM R5.0.0 |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| contact_information_identifier (semi-optional) | Contact information identifier | The identifier of the contact information related with the lead that will be returned as results. The allowed contact information identifier fields are the following:
| ||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the account related with the lead that should be returned as a result. The allowed account identifier fields are the following:
| ||||||
type_identifier | Lead type identifier | The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:
| ||||||
category_identifier (semi-optional) | Lead Category Identifier | The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:
| ||||||
source_identifier (semi-optional) | Lead Source Identifier | The identifier of the source lead. The allowed lead source identifier fields are the following:
| ||||||
importance (semi-optional) | String | The importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3 | ||||||
priority (semi-optional) | String | The priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6 | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...