ConnectCloud Developers

List the pipeline stages (tenant:crm:read)

GET /api/crm/v1/stages

Module: CRM · operationId: listStages · Tag: Pipeline · Auth: access token (Authorization: Bearer <accessToken>)

The tenant's stages in pipeline order, archived ones included; the defaults (see Model) while the tenant saved none (default: true).

Responses

  • 200 Stages (application/json)
  • 401 Missing, invalid or expired token (no body).
  • 403 The token lacks the permission (insufficient permissions) or has no active tenant. (application/json)
  • 500 Unexpected error; details are only logged. (application/json)

Fields of the 200 answer:

  • default (boolean, required): The tenant has not saved its own stages; these are the defaults.
  • items (array of Stage, required): Stages in pipeline order.
    • archived (boolean, required): Archived stages cannot be chosen for opportunities.
    • key (string, required): Stable key of the stage (stored on opportunities). (max length 64)
    • label (string, required): Display name. (max length 100)
    • phase (string, required): Phase the stage belongs to. (one of open, won, lost)
    • position (integer, required): Order in the pipeline.
    • probability (integer, required): Default win probability of an opportunity entering the stage. (max 100)
    • used (boolean, required, read-only): Opportunities are in the stage; it can then only be archived, not removed.

Example 200 answer:

{
  "default": false,
  "items": [
    {
      "archived": false,
      "key": "PROSPECTING",
      "label": "Erstkontakt",
      "phase": "open",
      "position": 1,
      "probability": 10,
      "used": true
    },
    {
      "archived": false,
      "key": "QUALIFICATION",
      "label": "Qualifizierung",
      "phase": "open",
      "position": 2,
      "probability": 30,
      "used": true
    },
    {
      "archived": false,
      "key": "PROPOSAL",
      "label": "Angebot",
      "phase": "open",
      "position": 3,
      "probability": 50,
      "used": true
    },
    {
      "archived": false,
      "key": "NEGOTIATION",
      "label": "Verhandlung",
      "phase": "open",
      "position": 4,
      "probability": 75,
      "used": false
    },
    {
      "archived": false,
      "key": "CLOSED_WON",
      "label": "Gewonnen",
      "phase": "won",
      "position": 5,
      "probability": 100,
      "used": true
    },
    {
      "archived": false,
      "key": "CLOSED_LOST",
      "label": "Verloren",
      "phase": "lost",
      "position": 6,
      "probability": 0,
      "used": true
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/crm/v1/stages' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI