Skip to main content

PipeDTO

Pipeline information object.

idint64

Pipeline ID

Example: 1
namestring

Pipeline name

Example: Sales Pipeline
ordersint32

Pipeline order

Example: 1
pipeStatuses object[]

Pipeline stages.

  • Array [
  • idint64

    Pipeline stage ID

    Example: 1
    namestring

    Pipeline stage name

    Example: New Lead
    ordersint32

    Pipeline stage order

    Example: 1
    colorstring

    Pipeline stage color

    Example: #FF0000
    typePipeStatusType

    Pipeline stage type enum.

    Possible values: [FIRST, SIMPLE, SUCCESS, FAILED]

    Example: FIRST
    pipeIdint64

    Pipeline ID

    Example: 1
    pipeNamestring

    Pipeline name

    Example: Sales Pipeline
    deletedTimestampint64nullable

    Deletion time (epoch seconds, null if active)

    Example: null
  • ]
  • PipeDTO
    {
    "id": 1,
    "name": "Sales Pipeline",
    "orders": 1,
    "pipeStatuses": [
    {
    "id": 1,
    "name": "New Lead",
    "orders": 1,
    "color": "#FF0000",
    "type": "FIRST",
    "pipeId": 1,
    "pipeName": "Sales Pipeline",
    "deletedTimestamp": null
    }
    ]
    }