API Docs / Schemas / PipelineStageDto

PipelineStageDto

DTO for a user-defined stage on a sales pipeline

Properties

Name Type Description
codestring

The unique code for this stage

The unique code for this stage

namestring

The display name of this stage

The display name of this stage

descriptionstring

Optional description of what this stage represents

Optional description of what this stage represents

iconstring

Optional Lucide icon name for visual identification

Optional Lucide icon name for visual identification

colorstring

Optional hex colour for visual identification

Optional hex colour for visual identification

sortOrderinteger

The display order for this stage

The display order for this stage

showOnClientPageboolean

Whether a client's pipeline card is shown on their client page while it sits in this stage.
Defaults to true; turn off for terminal stages (e.g. "Won").

Whether a client's pipeline card is shown on their client page while it sits in this stage.
Defaults to true; turn off for terminal stages (e.g. "Won").

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "icon": "string",
  "color": "string"
}

Contained in Schemas