Config

Retrieve a CRM pipeline status

Work with CRM pipeline status.Retrieves the CRM pipeline status with the given ID.

get/admin/config/crm-pipeline/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/crm-pipeline/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired CRM pipeline status.

Response

namestring required

CRM pipeline status name

stagestring

CRM status stage: 'crm_lead_stage_new', 'crm_lead_stage_in_progress', 'crm_lead_stage_qualified', 'crm_lead_stage_unqualified'. Default: 'crm_lead_stage_new'

labelstring

CRM status label: 'default', ''primary', 'success', 'info', 'warning', 'danged', 'pending'. Default: 'default',

bg_colorstring

CRM status background color in rgba format, used in tables. Default: 'rgba(255,255,255,1)'

is_bg_colorboolean

If set to true then 'bg_color' will be used in tables. Default: 'false'

due_daysnumber

The number of days after which you should change the status. Otherwise the lead will overdue. Default: 0

idnumber required

CRM pipeline status ID

is_basenumber

If it is base status here will be 1. Values 1, 0.

positionnumber

The position of the status in list.

Example response

{
  "name": "New",
  "stage": "crm_lead_stage_new",
  "label": "default",
  "bg_color": "rgba(255,255,255,1)",
  "is_bg_color": false,
  "due_days": 3,
  "id": 1,
  "is_base": 1,
  "position": 8
}

Changes

No recorded changes to this operation across all 1 revision of this API.