GET leads/configuration/statuses/list

Available from CRM.COM R9.0.0

This method returns the statuses that are allowed to be used by leads of specific type. Multiple statuses are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

lead_type_identifier

(mandatory)

Lead Type Identifier

The identifier of the type of the lead that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed lead type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the lead type

name

(semi-optional)

String

The name of the lead type

alternative_code

(semi-optional)

String

The alternative code of lead type

life_cycle_state

(optional)

Sting

The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are:

PENDING, IN PROGRESS, LOST, WON and CANCELLED

CANCELLED life cycle state available from CRM.COM R11.1.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 type status
status	Lead Status Object	The actual status provided by the lead type status

Referred Objects Response Data

lead_status object response data

Name	Type	Description
id	String	The ID of the retrieved lead status
name	String	The name of the retrieved lead status
alternative_code	String	The alternative code of the retrieved lead status
description	String	A description of the retrieved lead status
life_cycle_state	String	The life cycle state related with the retrieved lead status. The supported life cycle states are the following: PENDING, IN_PROGRESS, LOST, WON, CANCELLED CANCELLED life cycle state available from CRM.COM R11.1.0

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
       "default": true,
       "status":
       {
           "life_cycle_state": "PENDING",
           "id": "ECE7C00893674BE9AFC18C5F98A08D98",
           "name": "Pending",
           "description": "Pending Lead",
           "alternative_code": "P"
       },
       "id": "D26B1A1D3CA3CC0BA3DBE334BCF0B10C"
   }