Contents
On this page

List Pipelines - Plugixa CRM

GET /plugixa-crm/v1/pipelines

List every sales pipeline with its stages, to find the pipeline_id and stage_id values opportunities take.

Any user with access to Plugixa CRM.

Note. Not paged: the whole list comes back in one response, without meta.

Request

GET https://your-site.example/wp-json/plugixa-crm/v1/pipelines

Responses

200 OK. data is every pipeline.

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Sales Pipeline",
      "slug": "sales-pipeline",
      "entity_type": "opportunity",
      "is_default": 1,
      "position": 0,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "stages": [
        {
          "id": 1,
          "pipeline_id": 1,
          "name": "Qualification",
          "slug": "qualification",
          "type": "open",
          "probability": 10,
          "color": "#64748b",
          "position": 0,
          "created_at": "2026-11-12 09:30:00"
        },
        {
          "id": 2,
          "pipeline_id": 1,
          "name": "Needs Analysis",
          "slug": "needs-analysis",
          "type": "open",
          "probability": 25,
          "color": "#0ea5e9",
          "position": 1,
          "created_at": "2026-11-12 09:30:00"
        },
        {
          "id": 3,
          "pipeline_id": 1,
          "name": "Proposal",
          "slug": "proposal",
          "type": "open",
          "probability": 50,
          "color": "#6366f1",
          "position": 2,
          "created_at": "2026-11-12 09:30:00"
        },
        {
          "id": 4,
          "pipeline_id": 1,
          "name": "Negotiation",
          "slug": "negotiation",
          "type": "open",
          "probability": 75,
          "color": "#a855f7",
          "position": 3,
          "created_at": "2026-11-12 09:30:00"
        },
        {
          "id": 5,
          "pipeline_id": 1,
          "name": "Closed Won",
          "slug": "closed-won",
          "type": "won",
          "probability": 100,
          "color": "#16a34a",
          "position": 4,
          "created_at": "2026-11-12 09:30:00"
        },
        {
          "id": 6,
          "pipeline_id": 1,
          "name": "Closed Lost",
          "slug": "closed-lost",
          "type": "lost",
          "probability": 0,
          "color": "#dc2626",
          "position": 5,
          "created_at": "2026-11-12 09:30:00"
        }
      ]
    }
  ]
}
Field Type Meaning
data[].id integer The pipeline’s id
data[].name string Its name
data[].is_default integer 1 for the pipeline new opportunities go to when none is given
data[].stages[].id integer A stage’s id
data[].stages[].type string open, won or lost: the status an opportunity takes in this stage
data[].stages[].probability integer The probability an opportunity takes in this stage
data[].stages[].position integer Order in the pipeline, from 0

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-crm/v1/pipelines" \
  -u "admin:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/pipelines');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-crm/v1/pipelines', {
  headers: {
    'Authorization': auth,
  },
});
const { data, meta } = await response.json();

Quick Links

Share