The Pipeline object

This object represents a sales pipeline and the stages involved in a sale process.

{
    "id": "URDzWNO4JlMHWJIPWygY",
    "name": "default",
    "stages": [
        {
            "id": "TPtDajSfPcfd9WC8JJQ9",
            "name": "prospect",
            "type": "open",
            "createdAt": "2024-03-15T23:20:29.710Z",
            "updatedAt": "2024-03-20T17:37:00.697Z"
        },
        {
            "id": "9GymqnzjzaHxZYQkVFk8",
            "name": "qualified",
            "type": "open",
            "createdAt": "2024-03-15T23:20:29.720Z",
            "updatedAt": "2024-03-20T17:37:00.715Z"
        },
        {
            "id": "YomKyyvz7EEVIy6yzJsL",
            "name": "closed-won",
            "type": "won",
            "createdAt": "2024-03-15T23:20:29.737Z",
            "updatedAt": "2024-03-20T17:37:00.587Z"
        },
        {
            "id": "hL3APJwAkGdY3vlLWP5Z",
            "name": "closed-lost",
            "type": "lost",
            "createdAt": "2024-03-15T23:20:29.716Z",
            "updatedAt": "2024-03-20T17:37:00.689Z"
        }
    ],
    "createdAt": "2024-03-15T23:20:29.016Z",
    "updatedAt": "2024-03-20T17:37:00.871Z"
}

Attributes:

  • id (string): A unique identifier for the pipeline.

  • name (string): The name of the pipeline.

  • stages (array of objects): A list of stages within the pipeline. Each stage includes:

    • id (string): A unique identifier for the stage.

    • name (string): The name of the stage.

    • type (string): The type of the stage. Valid values are:

      • "open"

      • "won"

      • "lost"

    • createdAt (string, format: date-time): The date and time when the stage was created, in the date-time notation as defined by RFC 3339 (e.g., 2024-03-15T23:20:29.710Z).

    • updatedAt (string, format: date-time): The date and time when the stage was last updated, as defined by RFC 3339.

  • createdAt (string, format: date-time): The date and time when the pipeline was created, as defined by RFC 3339.

  • updatedAt (string, format: date-time): The date and time when the pipeline was last updated, as defined by RFC 3339.

Last updated