v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Pipeline

Pipelines.get

Returns Pipeline with given id

get/entities/Pipelines/{id}

Path parameters

idstring uuid required

ID of Pipeline to retrieve

Response

Pipeline data

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "color": 1,
    "name": "string",
    "revision": 1,
    "steps": [
      {
        "description": "string",
        "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "percent": 1,
        "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "sort_order": 1,
        "timeframe": 1,
        "revision": 1
      }
    ]
  }
}