GET activities/configuration/statuses/list

Available from CRM.COM R6.0.0

This method returns the statuses that are allowed to be used by activities 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

activity_type_identifier

(mandatory)

activity Type Identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the activity type

name

(semi-optional)

String

The code of the activity type

alternative_code

(semi-optional)

String

The alternative code of the activity 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, COMPLETED and CANCELLED

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 activity type status
default	Boolean	Determines if the activity type status is the default status or not
status	Activity Status Object	The actual status provided by the activity type status

Referred Objects Response Data

activity_status object response data

Name	Type	Description
id	String	The ID of the retrieved activity status
name	String	The name of the retrieved activity status
alternative_code	String	The alternative code of the retrieved activity status
description	String	A description of the retrieved activity status
life_cycle_state	String	The life cycle state related with the retrieved activity status. The supported life cycle states are the following: PENDING, IN_PROGRESS,COMPLETED,CANCELLED

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "COMPLETED",
                "id": "2",
                "name": "Closed",
                "description": "Closed Status",
                "alternative_code": "CL"
            },
            "id": "32E020413B774129A0D9C5C8F9DE248D"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "IN_PROGRESS",
                "id": "1D541C2D984D0BE73D2B1A7133C886A6",
                "name": "Delivered",
                "alternative_code": "DE"
            },
            "id": "B2BDD91FA6F44F899BDC5A8BEFD63F18"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "IN_PROGRESS",
                "id": "F6420AC12C68BBC6C9B7600E0E1BA6DF",
                "name": "In Progress",
                "description": "In Progress Status",
                "alternative_code": "IP"
            },
            "id": "DD03E6493B4543E3ACC8C1E694828956"
        },
        {
            "default": true,
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "92A272A726DB662017BE1D9207357125",
                "name": "To Be Approved ",
                "alternative_code": "TBA"
            },
            "id": "2C80A55289C34D489389AA0B8E140C31"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "PENDING",
                "id": "63ADCD4D9DE09258EE5FA24B8ACF40BF",
                "name": "Assigned",
                "alternative_code": "AS"
            },
            "id": "934840C37FB14BBB945665B8A0CEAECD"
        },
        {
            "default": false,
            "status":
            {
                "life_cycle_state": "CANCELLED",
                "id": "9BF9F6E1C1F54081A67BBD72CADE3BC9",
                "name": "Cancelled",
                "alternative_code": "C"
            },
            "id": "6E5B6B02C4964629967CB704209F83C5"
        }
    ]
}