List Pipelines

Retrieve all pipelines for the authenticated customer

Overview

Retrieve a list of all pipelines associated with the authenticated customer. Each pipeline includes its jobs and current status.

Authentication

This endpoint requires authentication. The customer_id is extracted from the authentication token.

Example

List All Pipelines

GET /platform/pipelines

Response (200 OK):

[
  {
    "id": 1,
    "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
    "customer_id": "acme_corp",
    "user_id": "[email protected]",
    "name": "Orders Data Pipeline",
    "description": "Daily extraction of orders data from PostgreSQL",
    "cron": "0 6 * * *",
    "last_status": "SUCCESS",
    "jobs": [
      {
        "id": 1,
        "job_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d_0",
        "job_status": "SUCCESS",
        "input": {
          "connector": "jdbc",
          "plugin": "postgresql",
          "table_name": "orders"
        },
        "output": {
          "plugin": "dadosfera_snowflake",
          "raw": {
            "table_name": "orders",
            "table_schema": "RAW_DATA"
          }
        }
      }
    ]
  },
  {
    "id": 2,
    "pipeline_id": "a9f82c14_7e21_4b5a_8c9d_12345abcdef0",
    "customer_id": "acme_corp",
    "user_id": "[email protected]",
    "name": "HubSpot Contacts Pipeline",
    "description": "Sync contacts from HubSpot",
    "cron": "0 */6 * * *",
    "last_status": "CREATED",
    "jobs": [
      {
        "id": 2,
        "job_id": "a9f82c14_7e21_4b5a_8c9d_12345abcdef0_0",
        "job_status": "PENDING",
        "input": {
          "connector": "singer",
          "plugin": "hubspot",
          "table_name": "contacts"
        },
        "output": {
          "plugin": "dadosfera_snowflake",
          "raw": {
            "table_name": "hubspot_contacts",
            "table_schema": "RAW_DATA"
          }
        }
      }
    ]
  }
]

Response Structure

Pipeline Object

FieldTypeDescription
idintegerInternal database ID
pipeline_idstringUnique pipeline identifier
customer_idstringCustomer identifier
user_idstringUser who created the pipeline
namestringPipeline display name
descriptionstringPipeline description
cronstringCron schedule expression (null for manual)
last_statusstringLast execution status
jobsarrayList of jobs in the pipeline

Job Object

FieldTypeDescription
idintegerInternal database ID
job_idstringUnique job identifier
job_statusstringCurrent job status
inputobjectJob input configuration
outputobjectJob output configuration
memory_allocated_mbintegerMemory allocation (if set)

Pipeline Status Values

StatusDescription
PENDINGPipeline created, waiting for first execution
CREATEDPipeline ready for execution
RUNNINGPipeline currently executing
SUCCESSLast execution completed successfully
FAILEDLast execution failed

Error Responses

500 Internal Server Error

{
  "msg": "There was an error retrieving the pipelines.",
  "error": "Database connection error"
}

Notes

  • Returns an empty array [] if no pipelines exist for the customer
  • Pipelines are returned with their associated jobs using eager loading
  • For detailed information about a specific pipeline, use GET /platform/pipeline/:pipelineId
Language
Credentials
Header
Click Try It! to start a request and see the response here!