v1

latestOpenAPI 3.0.02026-08-04109109370.6 KB
Stagesets (Pipelines)

Get a list of pipelines

Gets a list of pipelines that leads can be assigned to. Pipelines are also known as stagesets.

get/stagesets

Response

OK

idstring

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

namestring

The name of the pipeline

defaultboolean

Whether this is the default pipeline for new leads.

canAccessboolean

Whether the user can access the stageset based on the current Nutshell plan.

statusinteger

The status of the stageset. '1' for active, '2' for draft, '3' for retired

Example response

[
  {
    "id": "3-contacts",
    "name": "Preimum Prospects Pipeline",
    "default": true,
    "canAccess": true
  }
]