Skip to main content
← All schemas

PipelineDetail

object

idrequired
Id

Opaque record id.

namerequired
string
lead_typesrequired
array of LeadType
is_defaultrequired
boolean
sort_orderrequired
integer
lead_countrequired
integer or null

Leads in it (deleted ones left out); null for members without settings access.

statusesrequired
array of PipelineStatus
Example
{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "lead_types": [
    "buy"
  ],
  "is_default": true,
  "sort_order": 0,
  "lead_count": 0,
  "statuses": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "pipeline_id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "category": "open",
      "color": "string",
      "sort_order": 0,
      "is_default": true,
      "is_active": true,
      "sla_minutes": 0,
      "requirements": {
        "follow_up": "required",
        "site_visit": "required",
        "note": "required",
        "deal": "required",
        "fields": [
          "string"
        ]
      },
      "lead_count": 0,
      "sub_statuses": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "status_id": "cmusrceel0000q7kaafxqi1om",
          "key": "string",
          "name": "string",
          "sort_order": 0,
          "is_active": true,
          "requirements": {
            "follow_up": "required",
            "site_visit": "required",
            "note": "required",
            "deal": "required",
            "fields": [
              null
            ]
          },
          "auto_follow_up_minutes": 0,
          "counts_as_contact": true,
          "lead_count": 0
        }
      ]
    }
  ]
}