deal_pipeline

idinteger

The ID of the pipeline

namestring

The name of the pipeline

descriptionstring

positioninteger

Order of the pipeline in the funnel list

allow_dealsboolean

Whether the board accepts deals

allow_tasksboolean

Whether the board also accepts tasks. A column mixes both, and they share one ordering.

lead_capture_enabledboolean

Whether an incoming conversation on a linked inbox opens a deal here

block_duplicate_leadsboolean

Whether a contact who already has an open deal here is skipped by lead capture

new_card_placementstring

Where a card -- deal or task -- is inserted in its stage when it opens. The board keeps a manual order, so this only decides the arrival point and never re-sorts cards that are already on it.

Possible values: [top, bottom]

inbox_idsinteger[]

Inboxes this pipeline captures leads from

lead_automationsstring[]

Names of the active automation rules that also open deals in this pipeline. Reported so the settings screen can warn that two sources would capture the same contact.

created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of the last update

deal_stages object[]

The columns of the board, in order

Array [

idinteger

The ID of the stage

deal_pipeline_idinteger

The pipeline the stage belongs to

namestring

The name of the stage, as the board column header shows it

nicknamestring

Short label used where the full name will not fit

objectivestring

What has to happen for a deal to leave this stage

colorstring

Hex colour of the column

Example: #2176ff

stage_typestring

entry is where captured leads land and where a migrated deal falls back to; conclusion closes the funnel. Everything else is regular.

Possible values: [regular, entry, conclusion]

probabilityinteger

Chance of closing a deal that reaches this stage, in percent. Null when the stage has none set, and the client falls back to the stage's position.

Possible values: >= 0 and <= 100

orderinteger

Position of the column in the board

created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of the last update

]

members object[]

Per-user access to this pipeline. Only administrators can read or change it; for anyone else the list comes back empty.

Array [

idinteger

user_idinteger

can_view_dealsboolean

can_create_dealsboolean

can_edit_dealsboolean

can_delete_dealsboolean

can_view_tasksboolean

can_create_tasksboolean

can_edit_tasksboolean

can_delete_tasksboolean

]

permissions object

What the authenticated user may do in this pipeline, already resolved

deals object

can_viewboolean

can_createboolean

can_editboolean

can_deleteboolean

tasks object

can_viewboolean

can_createboolean

can_editboolean

can_deleteboolean

deal_pipeline

{
  "id": 0,
  "name": "string",
  "description": "string",
  "position": 0,
  "allow_deals": true,
  "allow_tasks": true,
  "lead_capture_enabled": true,
  "block_duplicate_leads": true,
  "new_card_placement": "top",
  "inbox_ids": [
    0
  ],
  "lead_automations": [
    "string"
  ],
  "created_at": 0,
  "updated_at": 0,
  "deal_stages": [
    {
      "id": 0,
      "deal_pipeline_id": 0,
      "name": "string",
      "nickname": "string",
      "objective": "string",
      "color": "#2176ff",
      "stage_type": "regular",
      "probability": 0,
      "order": 0,
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "members": [
    {
      "id": 0,
      "user_id": 0,
      "can_view_deals": true,
      "can_create_deals": true,
      "can_edit_deals": true,
      "can_delete_deals": true,
      "can_view_tasks": true,
      "can_create_tasks": true,
      "can_edit_tasks": true,
      "can_delete_tasks": true
    }
  ],
  "permissions": {
    "deals": {
      "can_view": true,
      "can_create": true,
      "can_edit": true,
      "can_delete": true
    },
    "tasks": {
      "can_view": true,
      "can_create": true,
      "can_edit": true,
      "can_delete": true
    }
  }
}