This API retrieves complete pipeline information including board details, phases, and stages with their associated criteria and fulfillment data. Perfect for building sales pipeline dashboards, CRM integrations, and workflow management systems.

💡 Pro Tip

Use this API to build dynamic sales pipeline visualizations and CRM integrations. The nested phase structure allows you to organize stages by sales phases (e.g., Lead, Qualification, Proposal, Closing) for better pipeline management.

Request Endpoint: https://app.zyntrohq.com/apis/public/fetchPipelineStages.php

Request Method: POST

Request Payload:

{
  "api_key": "your_zyntro_api_key",
  "org_id": "your_organization_id"
}

Response (JSON):

{
  "status": "success",
  "data": {
    "board_id": "pipeline_board_id",
    "board_name": "Sales Pipeline",
    "board_description": "Main sales pipeline for the organization",
    "phases": {
      "Lead": [
        {
          "stage_id": "stage_unique_id",
          "stage_name": "New Lead",
          "stage_description": "Initial contact stage",
          "stage_entry_criteria": {
            "criteria_type": "contact_made",
            "required_fields": ["name", "email"]
          },
          "stage_exit_criteria": {
            "criteria_type": "qualified",
            "required_actions": ["phone_call", "needs_assessment"]
          },
          "stage_fulfillment": {
            "completion_percentage": 25,
            "next_stage": "Qualified Lead"
          },
          "stage_display_order": 1
        }
      ],
      "Qualification": [
        {
          "stage_id": "stage_unique_id_2",
          "stage_name": "Qualified Lead",
          "stage_description": "Lead qualification stage",
          "stage_entry_criteria": {
            "criteria_type": "qualified",
            "required_fields": ["budget", "timeline"]
          },
          "stage_exit_criteria": {
            "criteria_type": "proposal_ready",
            "required_actions": ["needs_analysis", "proposal_created"]
          },
          "stage_fulfillment": {
            "completion_percentage": 50,
            "next_stage": "Proposal Sent"
          },
          "stage_display_order": 2
        }
      ]
    }
  }
}

Response Fields:

  • status: Indicates success or error status
  • data: Object containing pipeline information
  • board_id: Unique identifier for the pipeline board
  • board_name: Name of the pipeline board
  • board_description: Description of the pipeline board
  • phases: Object containing phases, where each phase key contains an array of stages
  • stage_id: Unique identifier for the stage
  • stage_name: Name of the stage
  • stage_description: Description of the stage
  • stage_entry_criteria: JSON object defining criteria for entering this stage
  • stage_exit_criteria: JSON object defining criteria for exiting this stage
  • stage_fulfillment: JSON object containing fulfillment data and next stage information
  • stage_display_order: Numeric order for displaying stages within phases

Notes:

  • This is a public API and requires an API Key. You can get your API Key from inside your Zyntro Account under Me > API Keys
  • Ensure that the api_key and org_id are valid and correspond to your Zyntro account credentials
  • The org_id should correspond to an existing organization within your account
  • Organization must be active for API calls to be processed successfully
  • Pipeline board must exist for the organization, otherwise an error will be returned
  • Stages are organized by phases in the response structure
  • Entry criteria, exit criteria, and fulfillment data are stored as JSON objects
  • Display order determines the sequence of stages within each phase