v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB

Stagesets (Pipelines)

Get a list of stages

get/stages

Response

Successful response

idstring

The API ID of this entity, formatted {integer}-{entityType}

namestring

The name of the stage

descriptionstring

The purpose of the stage

positioninteger

The order in which this stage appears in the pipeline

activeAvatarUrlstring

completeAvatarUrlstring

incompleteAvatarUrlstring

overdueAvatarUrlstring

numStepsnumber

The number of steps in this stage to move on to the next stage

canAdvanceStageboolean

Can we advance the lead to this stage?

Example response

[
  {
    "id": "3-contacts",
    "name": "Prospecting",
    "description": "Identify and qualify potential customers",
    "position": 1,
    "numSteps": 3,
    "canAdvanceStage": true,
    "links": [
      {
        "stageset": "1-stagesets"
      }
    ]
  }
]