Pipelines

Show pipeline

Returns detailed data on a pipeline

get/pipelines/fetch/{pipeline}

Request

  • Base URL: http://bonzo.site/api/v3
  • URL: http://bonzo.site/api/v3/pipelines/fetch/{pipeline}
  • Auth: HTTP bearer

Path parameters

pipelinestring required
Example:1

Response

Success

Example response

{
  "data": {
    "business": {
      "name": "Business name"
    },
    "name": "Pipeline name",
    "description": "Pipeline descripiton.",
    "business_tag": "mortgage",
    "start": "09:00:00",
    "end": "17:00:00",
    "enabled_days": [
      0,
      1,
      2,
      3,
      4
    ],
    "stages": [
      {
        "name": "Pipeline stage name",
        "color": "blue-50",
        "campaign": {
          "name": "Campaign name",
          "lead_zapier_uuid": "012a345b-1abc-1234-1a2b-1223456ab789c",
          "created_at": "2022-01-01T01:00:00.000000Z",
          "updated_at": "2022-01-01T01:00:00.000000Z",
          "sequence": {
            "name": "Sequence name",
            "campaign_id": "1",
            "enabled": true,
            "enable_date": "2022-01-01T01:00:00.000000Z",
            "type": "day_based",
            "prospect_zapier_uuid": "012a345b-1abc-1234-1a2b-1223456ab789c",
            "description": "Sequence description.",
            "start_campaign": "2022-01-01T01:00:00.000000Z",
            "cutoff_start": "09:00:00",
            "cutoff_stop": "18:00:00",
            "created_at": "2022-01-01T01:00:00.000000Z",
            "updated_at": "2022-01-01T01:00:00.000000Z"
          }
        },
        "created_at": "2022-01-01T01:00:00.000000Z",
        "updated_at": "2022-01-01T01:00:00.000000Z"
      }
    ],
    "cover_url": "https://example.com",
    "created_at": "2022-01-01T01:00:00.000000Z",
    "updated_at": "2022-01-01T01:00:00.000000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.