---
updatedAt: 2026-02-20T12:54:55.000Z
agentTools:
  projectIndex: https://api-docs.hevodata.com/llms.txt
---

# Get Pipeline

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Hevo Data",
    "description": "Hevo Data APIs allow users to manage their Pipelines in Hevo.<br/><br/>API Key and API Secret can be generated from `Account` > `API Keys` on Hevo UI.<br/>The key and secret generated should be used as Basic auth username and password to authenticate access.",
    "version": "v2.0"
  },
  "servers": [
    {
      "url": "https://us.hevodata.com"
    },
    {
      "url": "https://us2.hevodata.com"
    },
    {
      "url": "https://eu.hevodata.com"
    },
    {
      "url": "https://in.hevodata.com"
    },
    {
      "url": "https://asia.hevodata.com"
    },
    {
      "url": "https://au.hevodata.com"
    }
  ],
  "security": [
    {
      "BasicAuth": []
    }
  ],
  "paths": {
    "/api/public/v2.0/pipelines/{id}": {
      "get": {
        "tags": [
          "Pipelines"
        ],
        "summary": "Get Pipeline",
        "operationId": "getPipeline",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Pipeline found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pipeline"
                }
              }
            }
          },
          "404": {
            "description": "Pipeline not found."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Destination": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/DestinationType"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "PAUSED"
            ]
          },
          "health_status": {
            "type": "string",
            "enum": [
              "OK",
              "FAILED"
            ]
          },
          "failure_reason": {
            "type": "string"
          },
          "config": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "schedule": {
            "$ref": "#/components/schemas/Schedule"
          }
        }
      },
      "DestinationType": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "logo_url": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "documentation_url": {
            "type": "string"
          }
        }
      },
      "Schedule": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "REAL_TIME",
              "FREQUENCY",
              "CRON",
              "LOAD"
            ]
          },
          "schedule": {
            "type": "string"
          },
          "metadata": {
            "$ref": "#/components/schemas/ScheduleMetadata"
          },
          "schedule_configurable": {
            "type": "boolean"
          }
        }
      },
      "ScheduleMetadata": {
        "type": "object",
        "properties": {
          "frequency": {
            "type": "integer",
            "format": "int64"
          },
          "suggested_frequencies": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            }
          },
          "min_allowed_frequency": {
            "type": "integer",
            "format": "int64"
          },
          "max_allowed_frequency": {
            "type": "integer",
            "format": "int64"
          },
          "cron": {
            "type": "string"
          },
          "destination_tables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "destination_id": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "Pipeline": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "health_status": {
            "type": "string",
            "enum": [
              "OK",
              "FAILED"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "PAUSED"
            ]
          },
          "source": {
            "$ref": "#/components/schemas/Source"
          },
          "destination": {
            "$ref": "#/components/schemas/Destination"
          },
          "last_run_ts": {
            "type": "integer",
            "format": "int64"
          },
          "next_run_ts": {
            "type": "integer",
            "format": "int64"
          },
          "auto_mapping": {
            "type": "string",
            "enum": [
              "ENABLED",
              "DISABLED"
            ]
          },
          "schedule": {
            "$ref": "#/components/schemas/Schedule"
          },
          "webhook_url": {
            "type": "string"
          },
          "priority": {
            "type": "string",
            "enum": [
              "HIGH",
              "NORMAL"
            ]
          },
          "json_parsing_strategy": {
            "type": "string",
            "enum": [
              "FLAT",
              "SPLIT",
              "COLLAPSE",
              "NATIVE",
              "NATURAL",
              "COLLAPSE_EXCEPT_ARRAYS"
            ]
          }
        }
      },
      "Source": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/SourceType"
          },
          "health_status": {
            "type": "string",
            "enum": [
              "OK",
              "FAILED"
            ]
          },
          "failure_reason": {
            "type": "string"
          },
          "config": {
            "type": "object"
          }
        }
      },
      "SourceType": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "DATABASES_AND_FILES",
                "ENGINEERING",
                "FINANCE_AND_ACCOUNTING",
                "MARKETING_ANALYTICS",
                "PRODUCT",
                "SALES_AND_SUPPORT",
                "DATABASES",
                "CRM",
                "MARKETING",
                "CHAT",
                "FINANCE",
                "ECOMMERCE",
                "FILE_STORAGE",
                "ANALYTICS",
                "WAREHOUSES",
                "STREAMING",
                "COLLABORATION",
                "WEBHOOKS",
                "FREE",
                "UNUSED",
                "UPCOMING"
              ]
            }
          },
          "logo_url": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "documentation_url": {
            "type": "string"
          },
          "pauseable": {
            "type": "boolean"
          },
          "free": {
            "type": "boolean"
          },
          "disabled": {
            "type": "boolean"
          }
        }
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```